Class: Trav3::Travis

Inherits:
Object
  • Object
show all
Defined in:
lib/trav3.rb

Overview

An abstraction for the Travis CI v3 API

You can get started with the following.

require 'trav3'
project = Trav3::Travis.new("name/example")

When you instantiate an instance of Travis you get some default headers and default options.

Default Options

  • limit: 25 - for limiting data queries to 25 items at most

Options can be changed via the #options getter method which will give you a Options instance. All changes to it affect the options that the Travis instance will submit in url requests.

Default Headers

  • 'Content-Type': 'application/json'

  • 'Accept': 'application/json'

  • 'Travis-API-Version': 3

Headers can be changed via the #headers getter method which will give you a Headers instance. All changes to it affect the headers that the Travis instance will submit in url requests.

General Usage

project.owner
project.owner("owner")
project.repositories
project.repositories("owner")
project.repository
project.repository("owner/repo")
project.builds
project.build(12345)
project.build_jobs(12345)
project.job(1234)
project.log(1234)

# API Request Options
project.options.build({limit: 25})

# Pagination
builds = project.builds
builds.page.next
builds.page.first
builds.page.last

# Recommended inspection
builds.keys
builds.dig("some_key")

# Follow `@href`
repositories = project.repositories("owner")['repositories']
repositories.first.follow

Author:

Instance Attribute Summary collapse

Request Parameters collapse

API Endpoints collapse

Instance Method Summary collapse

Constructor Details

#initialize(repo) ⇒ Travis

Parameters:

  • repo (String)

    github_username/repository_name

Raises:

  • (InvalidRepository)

    if given input does not conform to valid repository identifier format



95
96
97
98
99
100
101
# File 'lib/trav3.rb', line 95

def initialize(repo)
  @api_endpoint = 'https://api.travis-ci.org'

  self.repository = repo

  initial_defaults
end

Instance Attribute Details

#api_endpointString

Returns API endpoint

Returns:

  • (String)

    API endpoint



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
# File 'lib/trav3.rb', line 86

class Travis
  attr_reader :api_endpoint
  attr_reader :options
  attr_reader :headers

  # @param repo [String] github_username/repository_name
  # @raise [InvalidRepository] if given input does not
  #   conform to valid repository identifier format
  # @return [Travis]
  def initialize(repo)
    @api_endpoint = 'https://api.travis-ci.org'

    self.repository = repo

    initial_defaults
  end

  # @!group Request Parameters

  # Set as the API endpoint
  #
  # @param endpoint [String] name for value to set
  # @return [Travis]
  def api_endpoint=(endpoint)
    validate_api_endpoint endpoint
    @api_endpoint = endpoint
  end

  # Set the authorization token in the requests' headers
  #
  # @param token [String] sets authorization token header
  # @return [Travis]
  def authorization=(token)
    validate_string token
    h('Authorization': "token #{token}")
  end

  # Set as many options as you'd like for collections queried via an API request
  #
  # @overload defaults(key: value, ...)
  #   @param key [Symbol] name for value to set
  #   @param value [Symbol, String, Integer] value for key
  # @return [Travis]
  def defaults(**args)
    (@options ||= Options.new).build(args)
    self
  end

  # Set as many headers as you'd like for API requests
  #
  #     h("Authorization": "token xxxxxxxxxxxxxxxxxxxxxx")
  #
  # @overload h(key: value, ...)
  #   @param key [Symbol] name for value to set
  #   @param value [Symbol, String, Integer] value for key
  # @return [Travis]
  def h(**args)
    (@headers ||= Headers.new).build(args)
    self
  end

  # Change the repository this instance of `Trav3::Travis` uses.
  #
  # @param repo_name [String] github_username/repository_name
  # @return [Travis]
  def repository=(repo_name)
    validate_repo_format repo_name
    @repo = sanitize_repo_name repo_name
  end

  # @!endgroup

  # @!group API Endpoints

  # Please Note that the naming of this endpoint may be changed. Our naming convention for this information is in flux. If you have suggestions for how this information should be presented please leave us feedback by commenting in this issue here or emailing support support@travis-ci.com.
  #
  # A list of all the builds in an "active" state, either created or started.
  #
  # ## Attributes
  #
  #     Name    Type    Description
  #     builds  Builds  The active builds.
  #
  # ## Actions
  #
  # **For Owner**
  #
  # Returns a list of "active" builds for the owner.
  #
  # GET <code>/owner/{owner.login}/active</code>
  #
  #     Template Variable  Type    Description
  #     owner.login        String  User or organization login set on GitHub.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /owner/danielpclark/active
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.active
  # # or
  # travis.active('danielpclark')
  # ```
  #
  # GET <code>/owner/{user.login}/active</code>
  #
  #     Template Variable  Type    Description
  #     user.login         String  Login set on GitHub.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /owner/danielpclark/active
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.active
  # # or
  # travis.active('danielpclark')
  # ```
  #
  # GET <code>/owner/{organization.login}/active</code>
  #
  #     Template Variable   Type    Description
  #     organization.login  String  Login set on GitHub.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /owner/travis-ci/active
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.active('travis-ci')
  # ```
  #
  # GET <code>/owner/github_id/{owner.github_id}/active</code>
  #
  #     Template Variable  Type     Description
  #     owner.github_id    Integer  User or organization id set on GitHub.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /owner/github_id/639823/active
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.active(639_823)
  # ```
  #
  # @param owner [String] username, organization name, or github id
  # @return [Success, RequestError]
  def active(owner = username)
    number?(owner) and return get("#{without_repo}/owner/github_id/#{owner}/active")
    get("#{without_repo}/owner/#{owner}/active")
  end

  # A beta feature (a Travis-CI feature currently in beta).
  #
  # ## Attributes
  #
  #     Name          Type     Description
  #     id            Integer  Value uniquely identifying the beta feature.
  #     name          String   The name of the feature.
  #     description   String   Longer description of the feature.
  #     enabled       Boolean  Indicates if the user has this feature turned on.
  #     feedback_url  String   Url for users to leave Travis CI feedback on this feature.
  #
  # ## Actions
  #
  # **Update**
  #
  # This will update a user's beta_feature.
  #
  # Use namespaced params in the request body to pass the `enabled` value (either true or false):
  #
  # ```bash
  # curl -X PATCH \
  #   -H "Content-Type: application/json" \
  #   -H "Travis-API-Version: 3" \
  #   -H "Authorization: token xxxxxxxxxxxx" \
  #   -d '{"beta_feature.enabled":true}' \
  #   https://api.travis-ci.com/user/1234/{beta_feature.id}
  # ```
  #
  # PATCH <code>/user/{user.id}/beta_feature/{beta_feature.id}</code>
  #
  #     Template Variable     Type     Description
  #     user.id               Integer  Value uniquely identifying the user.
  #     beta_feature.id       Integer  Value uniquely identifying the beta feature.
  #     Accepted Parameter    Type     Description
  #     beta_feature.id       Integer  Value uniquely identifying the beta feature.
  #     beta_feature.enabled  Boolean  Indicates if the user has this feature turned on.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.api_endpoint = 'https://api.travis-ci.com'
  # travis.authorization = 'xxxx'
  #
  # # Enable comic-sans for user id 119240
  # travis.beta_feature(:enable, 3, 119_240)
  #
  # # Disable comic-sans for user id 119240
  # travis.beta_feature(:disable, 3, 119_240)
  # ```
  #
  # **Delete**
  #
  # This will delete a user's beta feature.
  #
  # DELETE <code>/user/{user.id}/beta_feature/{beta_feature.id}</code>
  #
  #     Template Variable  Type     Description
  #     user.id            Integer  Value uniquely identifying the user.
  #     beta_feature.id    Integer  Value uniquely identifying the beta feature.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.api_endpoint = 'https://api.travis-ci.com'
  # travis.authorization = 'xxxx'
  #
  # # Disable comic-sans via delete for user id 119240
  # travis.beta_feature(:delete, 3, 119_240)
  # ```
  #
  # @param action [Symbol] either `:enable`, `:disable` or `:delete`
  # @param beta_feature_id [String, Integer] id for the beta feature
  # @param user_id [String] user id
  # @return [Success, RequestError]
  def beta_feature(action, beta_feature_id, user_id)
    validate_number beta_feature_id
    validate_number user_id

    if action != :delete
      params = { 'beta_feature.id' => beta_feature_id, 'beta_feature.enabled' => action == :enable }

      patch("#{without_repo}/user/#{user_id}/beta_feature/#{beta_feature_id}", params)
    else
      delete("#{without_repo}/user/#{user_id}/beta_feature/#{beta_feature_id}")
    end
  end

  # A list of beta features. Beta features are new Travis CI features in beta mode. They can be toggled on or off via the API or on this page on our site: https://travis-ci.com/features
  #
  # ## Attributes
  #
  #     Name           Type            Description
  #     beta_features  [Beta feature]  List of beta_features.
  #
  # ## Actions
  #
  # **Find**
  #
  # This will return a list of beta features available to a user.
  #
  # GET <code>/user/{user.id}/beta_features</code>
  #
  #     Template Variable  Type     Description
  #     user.id            Integer  Value  uniquely identifying the user.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /user/119240/beta_features
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.beta_features(119_240)
  # ```
  #
  # @note requests require an authorization token set in the headers. See: {authorization=}
  #
  # @param user_id [String, Integer] user id
  # @return [Success, RequestError]
  def beta_features(user_id)
    validate_number user_id

    get("#{without_repo}/user/#{user_id}/beta_features")
  end

  # Request migration to beta
  #
  # ## Attributes
  #     Name           Type     Description
  #     id             Unknown  The beta_migration_request's id.
  #     owner_id       Unknown  The beta_migration_request's owner_id.
  #     owner_name     Unknown  The beta_migration_request's owner_name.
  #     owner_type     Unknown  The beta_migration_request's owner_type.
  #     accepted_at    Unknown  The beta_migration_request's accepted_at.
  #     organizations  Unknown  The beta_migration_request's organizations.
  #
  # ## Actions
  #
  # **Create**
  #
  # Submits a request for beta migration
  #
  # POST <code>/user/{user.id}/beta_migration_request</code>
  #
  #     Template Variable  Type     Description
  #     user.id            Integer  Value uniquely identifying the user.
  #     Accepted Parameter                    Type     Description
  #     beta_migration_request.organizations  Unknown  The beta_migration_request's organizations.
  #
  #     Example: POST /user/119240/beta_migration_request
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.beta_migration_request(119_240)
  # ```
  #
  # @note requests require an authorization token set in the headers. See: {authorization=}
  #
  # @param user_id [String, Integer] user id
  # @return [Success, RequestError]
  def beta_migration_request(user_id)
    create("#{without_repo}/user/#{user_id}/beta_migration_request")
  end

  # The branch of a GitHub repository. Useful for obtaining information about the last build on a given branch.
  #
  # **If querying using the repository slug, it must be formatted using {http://www.w3schools.com/tags/ref_urlencode.asp standard URL encoding}, including any special characters.**
  #
  # ## Attributes
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #     Name  Type    Description
  #     name  String  Name of the git branch.
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is {https://developer.travis-ci.com/eager-loading eager loaded}.
  #
  #     Name              Type        Description
  #     name              String      Name of the git branch.
  #     repository        Repository  GitHub user or organization the branch belongs to.
  #     default_branch    Boolean     Whether or not this is the resposiotry's default branch.
  #     exists_on_github  Boolean     Whether or not the branch still exists on GitHub.
  #     last_build        Build       Last build on the branch.
  #
  # **Additional Attributes**
  #
  #     Name           Type     Description
  #     recent_builds  [Build]  Last 10 builds on the branch (when `include=branch.recent_builds` is used).
  #
  # ## Actions
  #
  # **Find**
  #
  # This will return information about an individual branch. The request can include either the repository id or slug.
  #
  # GET <code>/repo/{repository.id}/branch/{branch.name}</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     branch.name        String   Name of the git branch.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /repo/891/branch/master
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.branch('master')
  # ```
  #
  # GET <code>/repo/{repository.slug}/branch/{branch.name}</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     branch.name        String  Name of the git branch.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /repo/rails%2Frails/branch/master
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.branch('master')
  # ```
  #
  # @param name [String] the branch name for the current repository
  # @return [Success, RequestError]
  def branch(name)
    get("#{with_repo}/branch/#{name}")
  end

  # A list of branches.
  #
  # **If querying using the repository slug, it must be formatted using {http://www.w3schools.com/tags/ref_urlencode.asp standard URL encoding}, including any special characters.**
  #
  # ##Attributes
  #
  #     Name      Type      Description
  #     branches  [Branch]  List of branches.
  #
  # **Collection Items**
  #
  # Each entry in the **branches** array has the following attributes:
  #
  #     Name              Type        Description
  #     name              String      Name of the git branch.
  #     repository        Repository  GitHub user or organization the branch belongs to.
  #     default_branch    Boolean     Whether or not this is the resposiotry's default branch.
  #     exists_on_github  Boolean     Whether or not the branch still exists on GitHub.
  #     last_build        Build       Last build on the branch.
  #     recent_builds    [Build]      Last 10 builds on the branch (when `include=branch.recent_builds` is used).
  #
  # ## Actions
  #
  # **Find**
  #
  # This will return a list of branches a repository has on GitHub.
  #
  # GET <code>/repo/{repository.id}/branches</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     Query Parameter          Type       Description
  #     branch.exists_on_github  [Boolean]  Filters branches by whether or not the branch still exists on GitHub.
  #     exists_on_github         [Boolean]  Alias for branch.exists_on_github.
  #     include                  [String]   List of attributes to eager load.
  #     limit                    Integer    How many branches to include in the response. Used for pagination.
  #     offset                   Integer    How many branches to skip before the first entry in the response. Used for pagination.
  #     sort_by                  [String]   Attributes to sort branches by. Used for pagination.
  #
  #     Example: GET /repo/891/branches?limit=5&exists_on_github=true
  #
  # **Sortable by:** <code>name</code>, <code>last_build</code>, <code>exists_on_github</code>, <code>default_branch</code>, append <code>:desc</code> to any attribute to reverse order.
  # The default value is <code>default_branch</code>,<code>exists_on_github</code>,<code>last_build:desc</code>.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.options.build({limit: 5, exists_on_github: true})
  # travis.branches
  # ```
  #
  # GET <code>/repo/{repository.slug}/branches</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     Query Parameter          Type       Description
  #     branch.exists_on_github  [Boolean]  Filters branches by whether or not the branch still exists on GitHub.
  #     exists_on_github         [Boolean]  Alias for branch.exists_on_github.
  #     include                  [String]   List of attributes to eager load.
  #     limit                    Integer    How many branches to include in the response. Used for pagination.
  #     offset                   Integer    How many branches to skip before the first entry in the response. Used for pagination.
  #     sort_by                  [String]   Attributes to sort branches by. Used for pagination.
  #
  #     Example: GET /repo/rails%2Frails/branches?limit=5&exists_on_github=true
  #
  # **Sortable by:** <code>name</code>, <code>last_build</code>, <code>exists_on_github</code>, <code>default_branch</code>, append <code>:desc</code> to any attribute to reverse order.
  # The default value is <code>default_branch</code>,<code>exists_on_github</code>,<code>last_build:desc</code>.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.options.build({limit: 5, exists_on_github: true})
  # travis.branches
  # ```
  #
  # @return [Success, RequestError]
  def branches
    get("#{with_repo}/branches#{opts}")
  end

  # A list of broadcasts for the current user.
  #
  # ## Attributes
  #
  #     Name        Type         Description
  #     broadcasts  [Broadcast]  List of broadcasts.
  #
  # **Collection Items**
  #
  # Each entry in the broadcasts array has the following attributes:
  #
  #     Name        Type     Description
  #     id          Integer  Value uniquely identifying the broadcast.
  #     message     String   Message to display to the user.
  #     created_at  String   When the broadcast was created.
  #     category    String   Broadcast category (used for icon and color).
  #     active      Boolean  Whether or not the brodacast should still be displayed.
  #     recipient   Object   Either a user, organization or repository, or null for global.
  #
  # ## Actions
  #
  # **For Current User**
  #
  # This will return a list of broadcasts for the current user.
  #
  # GET <code>/broadcasts</code>
  #
  #     Query Parameter   Type       Description
  #     active            [Boolean]  Alias for broadcast.active.
  #     broadcast.active  [Boolean]  Filters broadcasts by whether or not the brodacast should still be displayed.
  #     include           [String]   List of attributes to eager load.
  #
  #     Example: GET /broadcasts
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.broadcasts
  # ```
  #
  # @note requests require an authorization token set in the headers. See: {authorization=}
  #
  # @return [Success, RequestError]
  def broadcasts
    get("#{without_repo}/broadcasts")
  end

  # An individual build.
  #
  # ## Attributes
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #     Name                 Type     Description
  #     id                   Integer  Value uniquely identifying the build.
  #     number               String   Incremental number for a repository's builds.
  #     state                String   Current state of the build.
  #     duration             Integer  Wall clock time in seconds.
  #     event_type           String   Event that triggered the build.
  #     previous_state       String   State of the previous build (useful to see if state changed).
  #     pull_request_title   String   Title of the build's pull request.
  #     pull_request_number  Integer  Number of the build's pull request.
  #     started_at           String   When the build started.
  #     finished_at          String   When the build finished.
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is eager loaded.
  #
  #     Name                 Type        Description
  #     id                   Integer     Value uniquely identifying the build.
  #     number               String      Incremental number for a repository's builds.
  #     state                String      Current state of the build.
  #     duration             Integer     Wall clock time in seconds.
  #     event_type           String      Event that triggered the build.
  #     previous_state       String      State of the previous build (useful to see if state changed).
  #     pull_request_title   String      Title of the build's pull request.
  #     pull_request_number  Integer     Number of the build's pull request.
  #     started_at           String      When the build started.
  #     finished_at          String      When the build finished.
  #     repository           Repository  GitHub user or organization the build belongs to.
  #     branch               Branch      The branch the build is associated with.
  #     tag                  Unknown     The build's tag.
  #     commit               Commit      The commit the build is associated with.
  #     jobs                 Jobs        List of jobs that are part of the build's matrix.
  #     stages               [Stage]     The stages of a build.
  #     created_by           Owner       The User or Organization that created the build.
  #     updated_at           Unknown     The build's updated_at.
  #
  # ## Actions
  #
  # **Find**
  #
  # This returns a single build.
  #
  # GET <code>/build/{build.id}</code>
  #
  #     Template Variable  Type     Description
  #     build.id           Integer  Value uniquely identifying the build.
  #
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /build/86601346
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.build(351_778_872)
  # ```
  #
  # **Cancel**
  #
  # This cancels a currently running build. It will set the build and associated jobs to "state": "canceled".
  #
  # POST <code>/build/{build.id}/cancel</code>
  #
  #     Template Variable  Type     Description
  #     build.id           Integer  Value uniquely identifying the build.
  #
  #     Example: POST /build/86601346/cancel
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.build(478_772_528, :cancel)
  # ```
  #
  # **Restart**
  #
  # This restarts a build that has completed or been canceled.
  #
  # POST <code>/build/{build.id}/restart</code>
  #
  #     Template Variable  Type     Description
  #     build.id           Integer  Value uniquely identifying the build.
  #
  #     Example: POST /build/86601346/restart
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.build(478_772_528, :restart)
  # ```
  #
  # @note POST requests require an authorization token set in the headers. See: {authorization=}
  #
  # @param build_id [String, Integer] the build id number
  # @param option [Symbol] options for :cancel or :restart
  # @raise [TypeError] if given build id is not a number
  # @return [Success, RequestError]
  def build(build_id, option = nil)
    validate_number build_id

    case option
    when :cancel
      post("#{without_repo}/build/#{build_id}/cancel")
    when :restart
      post("#{without_repo}/build/#{build_id}/restart")
    else
      get("#{without_repo}/build/#{build_id}")
    end
  end

  # A list of builds.
  #
  # ## Attributes
  #
  #     Name    Type     Description
  #     builds  [Build]  List of builds.
  #
  # **Collection Items**
  #
  # Each entry in the builds array has the following attributes:
  #
  #     Name                 Type        Description
  #     id                   Integer     Value uniquely identifying the build.
  #     number               String      Incremental number for a repository's builds.
  #     state                String      Current state of the build.
  #     duration             Integer     Wall clock time in seconds.
  #     event_type           String      Event that triggered the build.
  #     previous_state       String      State of the previous build (useful to see if state changed).
  #     pull_request_title   String      Title of the build's pull request.
  #     pull_request_number  Integer     Number of the build's pull request.
  #     started_at           String      When the build started.
  #     finished_at          String      When the build finished.
  #     repository           Repository  GitHub user or organization the build belongs to.
  #     branch               Branch      The branch the build is associated with.
  #     tag                  Unknown     The build's tag.
  #     commit               Commit      The commit the build is associated with.
  #     jobs                 Jobs        List of jobs that are part of the build's matrix.
  #     stages               [Stage]     The stages of a build.
  #     created_by           Owner       The User or Organization that created the build.
  #     updated_at           Unknown     The build's updated_at.
  #     request              Unknown     The build's request.
  #
  # ## Actions
  #
  # **For Current User**
  #
  # This returns a list of builds for the current user. The result is paginated.
  #
  # GET <code>/builds</code>
  #
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #     limit            Integer   How many builds to include in the response. Used for pagination.
  #     offset           Integer   How many builds to skip before the first entry in the response. Used for pagination.
  #     sort_by          [String]  Attributes to sort builds by. Used for pagination.
  #
  #     Example: GET /builds?limit=5
  #
  # **Sortable by:** <code>id</code>, <code>started_at</code>, <code>finished_at</code>, append <code>:desc</code> to any attribute to reverse order.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.options.build({limit: 5})
  # travis.builds(false)
  # ```
  #
  # **Find**
  #
  # This returns a list of builds for an individual repository. It is possible to use the repository id or slug in the request. The result is paginated. Each request will return 25 results.
  #
  # GET <code>/repo/{repository.id}/builds</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #
  #     Query Parameter       Type      Description
  #     branch.name           [String]  Filters builds by name of the git branch.
  #     build.created_by      [Owner]   Filters builds by the User or Organization that created the build.
  #     build.event_type      [String]  Filters builds by event that triggered the build.
  #     build.previous_state  [String]  Filters builds by state of the previous build (useful to see if state changed).
  #     build.state           [String]  Filters builds by current state of the build.
  #     created_by            [Owner]   Alias for build.created_by.
  #     event_type            [String]  Alias for build.event_type.
  #     include               [String]  List of attributes to eager load.
  #     limit                 Integer   How many builds to include in the response. Used for pagination.
  #     offset                Integer   How many builds to skip before the first entry in the response. Used for pagination.
  #     previous_state        [String]  Alias for build.previous_state.
  #     sort_by               [String]  Attributes to sort builds by. Used for pagination.
  #     state                 [String]  Alias for build.state.
  #
  #     Example: GET /repo/891/builds?limit=5
  #
  # **Sortable by:** <code>id</code>, <code>started_at</code>, <code>finished_at</code>, append <code>:desc</code> to any attribute to reverse order.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.options.build({limit: 5})
  # travis.builds
  # ```
  #
  # GET <code>/repo/{repository.slug}/builds</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #
  #     Query Parameter       Type      Description
  #     branch.name           [String]  Filters builds by name of the git branch.
  #     build.created_by      [Owner]   Filters builds by the User or Organization that created the build.
  #     build.event_type      [String]  Filters builds by event that triggered the build.
  #     build.previous_state  [String]  Filters builds by state of the previous build (useful to see if state changed).
  #     build.state           [String]  Filters builds by current state of the build.
  #     created_by            [Owner]   Alias for build.created_by.
  #     event_type            [String]  Alias for build.event_type.
  #     include               [String]  List of attributes to eager load.
  #     limit                 Integer   How many builds to include in the response. Used for pagination.
  #     offset                Integer   How many builds to skip before the first entry in the response. Used for pagination.
  #     previous_state        [String]  Alias for build.previous_state.
  #     sort_by               [String]  Attributes to sort builds by. Used for pagination.
  #     state                 [String]  Alias for build.state.
  #
  #     Example: GET /repo/rails%2Frails/builds?limit=5
  #
  # **Sortable by:** <code>id</code>, <code>started_at</code>, <code>finished_at</code>, append <code>:desc</code> to any attribute to reverse order.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.options.build({limit: 5})
  # travis.builds
  # ```
  #
  # @note requests may require an authorization token set in the headers. See: {authorization=}
  #
  # @param repo [Boolean] If true get repo builds, otherwise get user builds
  # @return [Success, RequestError]
  def builds(repo = true)
    repo and return get("#{with_repo}/builds#{opts}")
    get("#{without_repo}/builds#{opts}")
  end

  # A list of jobs.
  #
  # ## Attributes
  #
  #     Name  Type  Description
  #     jobs  [Job]  List of jobs.
  #
  # **Collection Items**
  #
  # Each entry in the jobs array has the following attributes:
  #
  #     Name           Type        Description
  #     id             Integer     Value uniquely identifying the job.
  #     allow_failure  Unknown     The job's allow_failure.
  #     number         String      Incremental number for a repository's builds.
  #     state          String      Current state of the job.
  #     started_at     String      When the job started.
  #     finished_at    String      When the job finished.
  #     build          Build       The build the job is associated with.
  #     queue          String      Worker queue this job is/was scheduled on.
  #     repository     Repository  GitHub user or organization the job belongs to.
  #     commit         Commit      The commit the job is associated with.
  #     owner          Owner       GitHub user or organization the job belongs to.
  #     stage          [Stage]     The stages of a job.
  #     created_at     String      When the job was created.
  #     updated_at     String      When the job was updated.
  #     config         Object      The job's config.
  #
  # ## Actions
  #
  # **Find**
  #
  # This returns a list of jobs belonging to an individual build.
  #
  # GET <code>/build/{build.id}/jobs</code>
  #
  #     Template Variable  Type     Description
  #     build.id           Integer  Value uniquely identifying the build.
  #
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /build/86601346/jobs
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.build_jobs(86_601_346)
  # ```
  #
  # **For Current User**
  #
  # This returns a list of jobs a current user has access to.
  #
  # GET <code>/jobs</code>
  #
  #     Query Parameter  Type      Description
  #     active           Unknown   Alias for job.active.
  #     created_by       Unknown   Alias for job.created_by.
  #     include          [String]  List of attributes to eager load.
  #     job.active       Unknown   Documentation missing.
  #     job.created_by   Unknown   Documentation missing.
  #     job.state        [String]  Filters jobs by current state of the job.
  #     limit            Integer   How many jobs to include in the response. Used for pagination.
  #     offset           Integer   How many jobs to skip before the first entry in the response. Used for pagination.
  #     sort_by          [String]  Attributes to sort jobs by. Used for pagination.
  #     state            [String]  Alias for job.state.
  #
  #     Example: GET /jobs?limit=5
  #
  # **Sortable by:** <code>id</code>, append <code>:desc</code> to any attribute to reverse order.
  # The default value is id:desc.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.options.build({limit: 5})
  # travis.build_jobs(false)
  # ```
  #
  # @note requests may require an authorization token set in the headers. See: {authorization=}
  #
  # @param build_id [String, Integer, Boolean] the build id number.  If falsey then get all jobs for current user
  # @return [Success, RequestError]
  def build_jobs(build_id)
    build_id and return get("#{without_repo}/build/#{build_id}/jobs")
    get("#{without_repo}/jobs#{opts}")
  end

  # A list of caches.
  #
  # If querying using the repository slug, it must be formatted using {http://www.w3schools.com/tags/ref_urlencode.asp standard URL encoding}, including any special characters.
  #
  # ## Attributes
  #
  #     Name    Type    Description
  #     branch  String  The branch the cache belongs to.
  #     match   String  The string to match against the cache name.
  #
  # ## Actions
  #
  # **Find**
  #
  # This returns all the caches for a repository.
  #
  # It's possible to filter by branch or by regexp match of a string to the cache name.
  #
  # ```bash
  # curl \
  #   -H "Content-Type: application/json" \
  #   -H "Travis-API-Version: 3" \
  #   -H "Authorization: token xxxxxxxxxxxx" \
  #   https://api.travis-ci.com/repo/1234/caches?branch=master
  # ```
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.options.build({branch: :master})
  # travis.caches
  # ```
  #
  # ```bash
  # curl \
  #   -H "Content-Type: application/json" \
  #   -H "Travis-API-Version: 3" \
  #   -H "Authorization: token xxxxxxxxxxxx" \
  #   https://api.travis-ci.com/repo/1234/caches?match=linux
  # ```
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.options.build({match: :linux})
  # travis.caches
  # ```
  #
  # GET <code>/repo/{repository.id}/caches</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     Query Parameter  Type      Description
  #     branch           [String]  Alias for caches.branch.
  #     caches.branch    [String]  Filters caches by the branch the cache belongs to.
  #     caches.match     [String]  Filters caches by the string to match against the cache name.
  #     include          [String]  List of attributes to eager load.
  #     match            [String]  Alias for caches.match.
  #
  #     Example: GET /repo/891/caches
  #
  # GET <code>/repo/{repository.slug}/caches</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     Query Parameter  Type      Description
  #     branch           [String]  Alias for caches.branch.
  #     caches.branch    [String]  Filters caches by the branch the cache belongs to.
  #     caches.match     [String]  Filters caches by the string to match against the cache name.
  #     include          [String]  List of attributes to eager load.
  #     match            [String]  Alias for caches.match.
  #
  #     Example: GET /repo/rails%2Frails/caches
  #
  # **Delete**
  #
  # This deletes all caches for a repository.
  #
  # As with `find` it's possible to delete by branch or by regexp match of a string to the cache name.
  #
  # ```bash
  # curl -X DELETE \
  #   -H "Content-Type: application/json" \
  #   -H "Travis-API-Version: 3" \
  #   -H "Authorization: token xxxxxxxxxxxx" \
  #   https://api.travis-ci.com/repo/1234/caches?branch=master
  # ```
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.options.build({branch: :master})
  # travis.caches(:delete)
  # ```
  #
  # DELETE <code>/repo/{repository.id}/caches</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #
  #     Example: DELETE /repo/891/caches
  #
  # DELETE <code>/repo/{repository.slug}/caches</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #
  #     Example: DELETE /repo/rails%2Frails/caches
  #
  # @note DELETE requests require an authorization token set in the headers. See: {authorization=}
  #
  # @param delete [Boolean] option for deleting cache(s)
  # @return [Success, RequestError]
  def caches(delete = false)
    without_limit do
      :delete.==(delete) and return delete("#{with_repo}/caches#{opts}")
      get("#{with_repo}/caches#{opts}")
    end
  end

  # An individual cron. There can be only one cron per branch on a repository.
  #
  # If querying using the repository slug, it must be formatted using {http://www.w3schools.com/tags/ref_urlencode.asp standard URL encoding}, including any special characters.
  #
  # ## Attributes
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #     Name  Type     Description
  #     id    Integer  Value uniquely identifying the cron.
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is {https://developer.travis-ci.com/eager-loading eager loaded}.
  #
  #     Name                             Type        Description
  #     id                               Integer     Value uniquely identifying the cron.
  #     repository                       Repository  Github repository to which this cron belongs.
  #     branch                           Branch      Git branch of repository to which this cron belongs.
  #     interval                         String      Interval at which the cron will run (can be "daily", "weekly" or "monthly").
  #     dont_run_if_recent_build_exists  Boolean     Whether a cron build should run if there has been a build on this branch in the last 24 hours.
  #     last_run                         String      When the cron ran last.
  #     next_run                         String      When the cron is scheduled to run next.
  #     created_at                       String      When the cron was created.
  #     active                           Unknown     The cron's active.
  #
  # ## Actions
  #
  # **Find**
  #
  # This returns a single cron.
  #
  # GET <code>/cron/{cron.id}</code>
  #
  #     Template Variable  Type     Description
  #     cron.id            Integer  Value uniquely identifying the cron.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.cron(id: 78_199)
  # ```
  #
  # **Delete**
  #
  # This deletes a single cron.
  #
  # DELETE <code>/cron/{cron.id}</code>
  #
  #     Template Variable  Type     Description
  #     cron.id            Integer  Value uniquely identifying the cron.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.cron(id: 78_199, delete: true)
  # ```
  #
  # **For Branch**
  #
  # This returns the cron set for the specified branch for the specified repository. It is possible to use the repository id or slug in the request.
  #
  # GET <code>/repo/{repository.id}/branch/{branch.name}/cron</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     branch.name        String   Name of the git branch.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /repo/891/branch/master/cron
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.cron(branch_name: 'master')
  # ```
  #
  # GET <code>/repo/{repository.slug}/branch/{branch.name}/cron</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     branch.name        String  Name of the git branch.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /repo/rails%2Frails/branch/master/cron
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.cron(branch_name: 'master')
  # ```
  #
  # **Create**
  #
  # This creates a cron on the specified branch for the specified repository. It is possible to use the repository id or slug in the request. Content-Type MUST be set in the header and an interval for the cron MUST be specified as a parameter.
  #
  # ```bash
  # curl -X POST \
  #   -H "Content-Type: application/json" \
  #   -H "Travis-API-Version: 3" \
  #   -H "Authorization: token xxxxxxxxxxxx" \
  #   -d '{ "cron.interval": "monthly" }' \
  #   https://api.travis-ci.com/repo/1234/branch/master/cron
  # ```
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.cron(branch_name: 'master', create: { 'interval' => 'monthly' })
  # ```
  #
  # POST <code>/repo/{repository.id}/branch/{branch.name}/cron</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     branch.name        String   Name of the git branch.
  #     Accepted Parameter                    Type     Description
  #     cron.interval                         String   Interval at which the cron will run (can be "daily", "weekly" or "monthly").
  #     cron.dont_run_if_recent_build_exists  Boolean  Whether a cron build should run if there has been a build on this branch in the last 24 hours.
  #
  #     Example: POST /repo/891/branch/master/cron
  #
  # POST <code>/repo/{repository.slug}/branch/{branch.name}/cron</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     branch.name        String  Name of the git branch.
  #     Accepted Parameter                    Type     Description
  #     cron.interval                         String   Interval at which the cron will run (can be "daily", "weekly" or "monthly").
  #     cron.dont_run_if_recent_build_exists  Boolean  Whether a cron build should run if there has been a build on this branch in the last 24 hours.
  #
  #     Example: POST /repo/rails%2Frails/branch/master/cron
  #
  # @param id [String, Integer] cron id to get or delete
  # @param branch_name [String] branch name to get cron or create
  # @param create [Hash] Properties for creating the cron.  `branch_name` keyword argument required and `interval` key/value required.
  # @param delete [Boolean] option for deleting cron.  Cron `id` keyword argument required.
  # @return [Success, RequestError]
  def cron(id: nil, branch_name: nil, create: nil, delete: false)
    if id
      validate_number id

      delete and return delete("#{without_repo}/cron/#{id}")
      return get("#{without_repo}/cron/#{id}")
    end
    raise ArgumentError, 'id or branch_name required' unless branch_name

    create and return create("#{with_repo}/branch/#{branch_name}/cron", cron_keys(create))
    get("#{with_repo}/branch/#{branch_name}/cron")
  end

  # A list of crons.
  #
  # If querying using the repository slug, it must be formatted using {http://www.w3schools.com/tags/ref_urlencode.asp standard URL encoding}, including any special characters.
  #
  # ## Attributes
  #
  #     Name   Type    Description
  #     crons  [Cron]  List of crons.
  #
  # **Collection Items**
  #
  # Each entry in the crons array has the following attributes:
  #
  #     Name                             Type        Description
  #     id                               Integer     Value uniquely identifying the cron.
  #     repository                       Repository  Github repository to which this cron belongs.
  #     branch                           Branch      Git branch of repository to which this cron belongs.
  #     interval                         String      Interval at which the cron will run (can be "daily", "weekly" or "monthly").
  #     dont_run_if_recent_build_exists  Boolean     Whether a cron build should run if there has been a build on this branch in the last 24 hours.
  #     last_run                         String      When the cron ran last.
  #     next_run                         String      When the cron is scheduled to run next.
  #     created_at                       String      When the cron was created.
  #     active                           Unknown     The cron's active.
  #
  # ## Actions
  #
  # **For Repository**
  #
  # This returns a list of crons for an individual repository. It is possible to use the repository id or slug in the request.
  #
  # GET <code>/repo/{repository.id}/crons</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #     limit            Integer   How many crons to include in the response. Used for pagination.
  #     offset           Integer   How many crons to skip before the first entry in the response. Used for pagination.
  #
  #     Example: GET /repo/891/crons?limit=5
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.options.build({limit: 5})
  # travis.crons
  # ```
  #
  # GET <code>/repo/{repository.slug}/crons</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #     limit            Integer   How many crons to include in the response. Used for pagination.
  #     offset           Integer   How many crons to skip before the first entry in the response. Used for pagination.
  #
  #     Example: GET /repo/rails%2Frails/crons?limit=5
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.options.build({limit: 5})
  # travis.crons
  # ```
  #
  # @return [Success, RequestError]
  def crons
    get("#{with_repo}/crons#{opts}")
  end

  # POST <code>/repo/{repository.id}/email_subscription</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #
  #     Example: POST /repo/891/email_subscription
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.email_resubscribe
  # ```
  #
  # POST <code>/repo/{repository.slug}/email_subscription</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #
  #     Example: POST /repo/rails%2Frails/email_subscription
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.email_resubscribe
  # ```
  #
  # @note requests require an authorization token set in the headers. See: {authorization=}
  #
  # @return [Success, RequestError]
  def email_resubscribe
    post("#{with_repo}/email_subscription")
  end

  # DELETE <code>/repo/{repository.id}/email_subscription</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #
  #     Example: DELETE /repo/891/email_subscription
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.email_unsubscribe
  # ```
  #
  # DELETE <code>/repo/{repository.slug}/email_subscription</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #
  #     Example: DELETE /repo/rails%2Frails/email_subscription
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.email_unsubscribe
  # ```
  #
  # @note requests require an authorization token set in the headers. See: {authorization=}
  #
  # @return [Success, RequestError]
  def email_unsubscribe
    delete("#{with_repo}/email_subscription")
  end

  # An individual environment variable.
  #
  # **If querying using the repository slug, it must be formatted using {http://www.w3schools.com/tags/ref_urlencode.asp standard URL encoding}, including any special characters.**
  #
  # ## Attributes
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is {https://developer.travis-ci.com/eager-loading eager loaded}.
  #
  #     Name    Type     Description
  #     id      String   The environment variable id.
  #     name    String   The environment variable name, e.g. FOO.
  #     value   String   The environment variable's value, e.g. bar.
  #     public  Boolean  Whether this environment variable should be publicly visible or not.
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #     Name    Type     Description
  #     id      String   The environment variable id.
  #     name    String   The environment variable name, e.g. FOO.
  #     public  Boolean  Whether this environment variable should be publicly visible or not.
  #
  # ## Actions
  #
  # **Find**
  #
  # This returns a single environment variable. It is possible to use the repository id or slug in the request.
  #
  # GET <code>/repo/{repository.id}/env_var/{env_var.id}</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     env_var.id         String   The environment variable id.
  #     Query Parameter  Type      Description
  #     env_var.id       String    The environment variable id.
  #     id               String    Alias for env_var.id.
  #     include          [String]  List of attributes to eager load.
  #     repository.id    Integer   Value uniquely identifying the repository.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.env_var('76f9d8bd-642d-47ed-9f35-4c25eb030c6c')
  # ```
  #
  # GET <code>/repo/{repository.slug}/env_var/{env_var.id}</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     env_var.id         String  The environment variable id.
  #     Query Parameter  Type      Description
  #     env_var.id       String    The environment variable id.
  #     id               String    Alias for env_var.id.
  #     include          [String]  List of attributes to eager load.
  #     repository.id    Integer   Value uniquely identifying the repository.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.env_var('76f9d8bd-642d-47ed-9f35-4c25eb030c6c')
  # ```
  #
  # **Update**
  #
  # This updates a single environment variable. It is possible to use the repository id or slug in the request.
  #
  # Use namespaced params in the request body to pass the new environment variable:
  #
  # ```bash
  # curl -X PATCH \
  #   -H "Content-Type: application/json" \
  #   -H "Travis-API-Version: 3" \
  #   -H "Authorization: token xxxxxxxxxxxx" \
  #   -d '{ "env_var.value": "bar", "env_var.public": false }' \
  #   https://api.travis-ci.com/repo/1234/{env_var.id}
  # ```
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.env_var('76f9d8bd-642d-47ed-9f35-4c25eb030c6c', update: { value: 'bar', public: false })
  # ```
  #
  # PATCH <code>/repo/{repository.id}/env_var/{env_var.id}</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     env_var.id         String   The environment variable id.
  #     Accepted Parameter  Type     Description
  #     env_var.name        String   The environment variable name, e.g. FOO.
  #     env_var.value       String   The environment variable's value, e.g. bar.
  #     env_var.public      Boolean  Whether this environment variable should be publicly visible or not.
  #
  # PATCH <code>/repo/{repository.slug}/env_var/{env_var.id}</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     env_var.id         String  The environment variable id.
  #     Accepted Parameter  Type     Description
  #     env_var.name        String   The environment variable name, e.g. FOO.
  #     env_var.value       String   The environment variable's value, e.g. bar.
  #     env_var.public      Boolean  Whether this environment variable should be publicly visible or not.
  #
  # **Delete**
  #
  # This deletes a single environment variable. It is possible to use the repository id or slug in the request.
  #
  # DELETE <code>/repo/{repository.id}/env_var/{env_var.id}</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     env_var.id         String   The environment variable id.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.env_var('76f9d8bd-642d-47ed-9f35-4c25eb030c6c', delete: true)
  # ```
  #
  # DELETE <code>/repo/{repository.slug}/env_var/{env_var.id}</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     env_var.id         String  The environment variable id.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.env_var('76f9d8bd-642d-47ed-9f35-4c25eb030c6c', delete: true)
  # ```
  #
  # @overload env_var(env_var_id)
  #   Gets current env var
  #   @param env_var_id [String] environment variable id
  # @overload env_var(env_var_id, action: params)
  #   Performs action per specific key word argument
  #   @param env_var_id [String] environment variable id
  #   @param update [Hash] Optional keyword argument. Update key pair with hash `{ value: "new value" }`
  #   @param delete [Boolean] Optional keyword argument. Use truthy value to delete current key pair
  # @return [Success, RequestError]
  def env_var(env_var_id, update: nil, delete: nil)
    raise 'Too many options specified' unless [update, delete].compact.count < 2

    validate_string env_var_id

    update and return patch("#{with_repo}/env_var/#{env_var_id}", env_var_keys(update))
    delete and return delete("#{with_repo}/env_var/#{env_var_id}")
    get("#{with_repo}/env_var/#{env_var_id}")
  end

  # A list of environment variables.
  #
  # **If querying using the repository slug, it must be formatted using {http://www.w3schools.com/tags/ref_urlencode.asp standard URL encoding}, including any special characters.**
  #
  # ## Attributes
  #
  #     Name      Type       Description
  #     env_vars  [Env var]  List of env_vars.
  #
  # ## Actions
  #
  # **For Repository**
  #
  # This returns a list of environment variables for an individual repository. It is possible to use the repository id or slug in the request.
  #
  # GET <code>/repo/{repository.id}/env_vars</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /repo/891/env_vars
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.env_vars
  # ```
  #
  # GET <code>/repo/{repository.slug}/env_vars</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /repo/rails%2Frails/env_vars
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.env_vars
  # ```
  #
  # **Create**
  #
  # This creates an environment variable for an individual repository. It is possible to use the repository id or slug in the request.
  #
  # Use namespaced params in the request body to pass the new environment variables:
  #
  # ```bash
  # curl -X POST \
  #   -H "Content-Type: application/json" \
  #   -H "Travis-API-Version: 3" \
  #   -H "Authorization: token xxxxxxxxxxxx" \
  #   -d '{ "env_var.name": "FOO", "env_var.value": "bar", "env_var.public": false }' \
  #   https://api.travis-ci.com/repo/1234/env_vars
  # ```
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.env_vars(name: 'FOO', value: 'bar', public: false)
  # ```
  #
  # POST <code>/repo/{repository.id}/env_vars</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     Accepted Parameter  Type     Description
  #     env_var.name        String   The environment variable name, e.g. FOO.
  #     env_var.value       String   The environment variable's value, e.g. bar.
  #     env_var.public      Boolean  Whether this environment variable should be publicly visible or not.
  #
  #     Example: POST /repo/891/env_vars
  #
  # POST <code>/repo/{repository.slug}/env_vars</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     Accepted Parameter  Type     Description
  #     env_var.name        String   The environment variable name, e.g. FOO.
  #     env_var.value       String   The environment variable's value, e.g. bar.
  #     env_var.public      Boolean  Whether this environment variable should be publicly visible or not.
  #
  #     Example: POST /repo/rails%2Frails/env_vars
  #
  # @note requests require an authorization token set in the headers. See: {authorization=}
  #
  # @param create [Hash] Optional argument.  A hash of the `name`, `value`, and `public` visibleness for a env var to create
  # @return [Success, RequestError]
  def env_vars(create = nil)
    create and return create("#{with_repo}/env_vars", env_var_keys(create))
    get("#{with_repo}/env_vars")
  end

  # A GitHub App installation.
  #
  # ## Attributes
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #     Name       Type     Description
  #     id         Integer  The installation id.
  #     github_id  Integer  The installation's id on GitHub.
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is {https://developer.travis-ci.com/eager-loading eager loaded}.
  #
  #     Name       Type     Description
  #     id         Integer  The installation id.
  #     github_id  Integer  The installation's id on GitHub.
  #     owner      Owner    GitHub user or organization the installation belongs to.
  #
  # ## Actions
  #
  # **Find**
  #
  # This returns a single installation.
  #
  # GET <code>/installation/{installation.github_id}</code>
  #
  #     Template Variable       Type     Description
  #     installation.github_id  Integer  The installation's id on GitHub.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.api_endpoint = 'https://api.travis-ci.com'
  # travis.authorization = 'xxxx'
  # travis.installation(617_754)
  # ```
  #
  # @param installation_id [String, Integer] GitHub App installation id
  # @return [Success, RequestError]
  def installation(installation_id)
    validate_number installation_id

    get("#{without_repo}/installation/#{installation_id}")
  end

  # An individual job.
  #
  # ## Attributes
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #     Name  Type     Description
  #     id    Integer  Value uniquely identifying the job.
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is eager loaded.
  #
  #     Name           Type        Description
  #     id             Integer     Value uniquely identifying the job.
  #     allow_failure  Unknown     The job's allow_failure.
  #     number         String      Incremental number for a repository's builds.
  #     state          String      Current state of the job.
  #     started_at     String      When the job started.
  #     finished_at    String      When the job finished.
  #     build          Build       The build the job is associated with.
  #     queue          String      Worker queue this job is/was scheduled on.
  #     repository     Repository  GitHub user or organization the job belongs to.
  #     commit         Commit      The commit the job is associated with.
  #     owner          Owner       GitHub user or organization the job belongs to.
  #     stage          [Stage]     The stages of a job.
  #     created_at     String      When the job was created.
  #     updated_at     String      When the job was updated.
  #
  # ## Actions
  #
  # **Find**
  #
  # This returns a single job.
  #
  # GET <code>/job/{job.id}</code>
  #
  #     Template Variable  Type     Description
  #     job.id             Integer  Value uniquely identifying the job.
  #
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /job/86601347
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.job(351_778_875)
  # ```
  #
  # **Cancel**
  #
  # This cancels a currently running job.
  #
  # POST <code>/job/{job.id}/cancel</code>
  #
  #     Template Variable  Type     Description
  #     job.id             Integer  Value uniquely identifying the job.
  #
  #     Example: POST /job/86601347/cancel
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.job(351_778_875, :cancel)
  # ```
  #
  # **Restart**
  #
  # This restarts a job that has completed or been canceled.
  #
  # POST <code>/job/{job.id}/restart</code>
  #
  #     Template Variable  Type     Description
  #     job.id             Integer  Value uniquely identifying the job.
  #
  #     Example: POST /job/86601347/restart
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.job(351_778_875, :restart)
  # ```
  #
  # **Debug**
  #
  # This restarts a job in debug mode, enabling the logged-in user to ssh into the build VM. Please note this feature is only available on the travis-ci.com domain, and those repositories on the travis-ci.org domain for which the debug feature is enabled. See this document for more details.
  #
  # POST <code>/job/{job.id}/debug</code>
  #
  #     Template Variable  Type     Description
  #     job.id             Integer  Value uniquely identifying the job.
  #
  #     Example: POST /job/86601347/debug
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.api_endpoint = 'https://api.travis-ci.com'
  # travis.authorization = 'xxxx'
  # travis.job(351_778_875, :debug)
  # ```
  #
  # @note POST requests require an authorization token set in the headers. See: {authorization=}
  # @note **Debug** is only available on the travis-ci.com domain, and those repositories on the travis-ci.org domain for which the debug feature is enabled.
  #
  # @param job_id [String, Integer] the job id number
  # @param option [Symbol] options for :cancel, :restart, or :debug
  # @return [Success, RequestError]
  def job(job_id, option = nil)
    case option
    when :cancel
      post("#{without_repo}/job/#{job_id}/cancel")
    when :restart
      post("#{without_repo}/job/#{job_id}/restart")
    when :debug
      post("#{without_repo}/job/#{job_id}/debug")
    else
      get("#{without_repo}/job/#{job_id}")
    end
  end

  # Users may add a public/private RSA key pair to a repository.
  # This can be used within builds, for example to access third-party services or deploy code to production.
  # Please note this feature is only available on the travis-ci.com domain.
  #
  # ## Attributes
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is {https://developer.travis-ci.com/eager-loading eager loaded}.
  #
  #     Name         Type    Description
  #     description  String  A text description.
  #     public_key   String  The public key.
  #     fingerprint  String  The fingerprint.
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #     Name         Type    Description
  #     description  String  A text description.
  #     public_key   String  The public key.
  #     fingerprint  String  The fingerprint.
  #
  # ## Actions
  #
  # **Find**
  #
  # Return the current key pair, if it exists.
  #
  # GET <code>/repo/{repository.id}/key_pair</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /repo/891/key_pair
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.api_endpoint = 'https://api.travis-ci.com'
  # travis.authorization = 'xxxx'
  # travis.key_pair
  # ```
  #
  # GET <code>/repo/{repository.slug}/key_pair</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /repo/rails%2Frails/key_pair
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.api_endpoint = 'https://api.travis-ci.com'
  # travis.authorization = 'xxxx'
  # travis.key_pair
  # ```
  #
  # **Create**
  #
  # Creates a new key pair.
  #
  # ```bash
  # curl -X POST \
  #   -H "Content-Type: application/json" \
  #   -H "Travis-API-Version: 3" \
  #   -H "Authorization: token xxxxxxxxxxxx" \
  #   -d '{ "key_pair.description": "FooBar", "key_pair.value": "xxxxx"}' \
  #   https://api.travis-ci.com/repo/1234/key_pair
  # ```
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.api_endpoint = 'https://api.travis-ci.com'
  # travis.authorization = 'xxxx'
  # travis.key_pair(create: { description: 'FooBar', value: OpenSSL::PKey::RSA.generate(2048).to_s })
  # ```
  #
  # POST <code>/repo/{repository.id}/key_pair</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     Accepted Parameter    Type    Description
  #     key_pair.description  String  A text description.
  #     key_pair.value        String  The private key.
  #
  #     Example: POST /repo/891/key_pair
  #
  # POST <code>/repo/{repository.slug}/key_pair</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     Accepted Parameter    Type    Description
  #     key_pair.description  String  A text description.
  #     key_pair.value        String  The private key.
  #
  #     Example: POST /repo/rails%2Frails/key_pair
  #
  # **Update**
  #
  # Update the key pair.
  #
  # ```bash
  # curl -X PATCH \
  #   -H "Content-Type: application/json" \
  #   -H "Travis-API-Version: 3" \
  #   -H "Authorization: token xxxxxxxxxxxx" \
  #   -d '{ "key_pair.description": "FooBarBaz" }' \
  #   https://api.travis-ci.com/repo/1234/key_pair
  # ```
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.api_endpoint = 'https://api.travis-ci.com'
  # travis.authorization = 'xxxx'
  # travis.key_pair(update: { description: 'FooBarBaz' })
  # ```
  #
  # PATCH <code>/repo/{repository.id}/key_pair</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     Accepted Parameter    Type    Description
  #     key_pair.description  String  A text description.
  #     key_pair.value        String  The private key.
  #
  #     Example: PATCH /repo/891/key_pair
  #
  # PATCH <code>/repo/{repository.slug}/key_pair</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     Accepted Parameter    Type    Description
  #     key_pair.description  String  A text description.
  #     key_pair.value        String  The private key.
  #
  #     Example: PATCH /repo/rails%2Frails/key_pair
  #
  # **Delete**
  #
  # Delete the key pair.
  #
  # DELETE <code>/repo/{repository.id}/key_pair</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #
  #     Example: DELETE /repo/891/key_pair
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.api_endpoint = 'https://api.travis-ci.com'
  # travis.authorization = 'xxxx'
  # travis.key_pair(delete: true)
  # ```
  #
  # DELETE <code>/repo/{repository.slug}/key_pair</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #
  #     Example: DELETE /repo/rails%2Frails/key_pair
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.api_endpoint = 'https://api.travis-ci.com'
  # travis.authorization = 'xxxx'
  # travis.key_pair(delete: true)
  # ```
  #
  # @note requests require an authorization token set in the headers. See: {authorization=}
  # @note API enpoint needs to be set to `https://api.travis-ci.com` See: {api_endpoint=}
  #
  # @overload key_pair()
  #   Gets current key_pair if any
  # @overload key_pair(action: params)
  #   Performs action per specific key word argument
  #   @param create [Hash] Optional keyword argument.  Create a new key pair from provided private key `{ description: "name", value: "private key" }`
  #   @param update [Hash] Optional keyword argument.  Update key pair with hash `{ description: "new name" }`
  #   @param delete [Boolean] Optional keyword argument.  Use truthy value to delete current key pair
  # @return [Success, RequestError]
  def key_pair(create: nil, update: nil, delete: nil)
    raise 'Too many options specified' unless [create, update, delete].compact.count < 2

    create and return create("#{with_repo}/key_pair", key_pair_keys(create))
    update and return patch("#{with_repo}/key_pair", key_pair_keys(update))
    delete and return delete("#{with_repo}/key_pair")
    get("#{with_repo}/key_pair")
  end

  # Every repository has an auto-generated RSA key pair. This is used when cloning the repository from GitHub and when encrypting/decrypting secure data for use in builds, e.g. via the Travis CI command line client.
  #
  # Users may read the public key and fingerprint via GET request, or generate a new key pair via POST, but otherwise this key pair cannot be edited or removed.
  #
  # ## Attributes
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is {https://developer.travis-ci.com/eager-loading eager loaded}.
  #
  #     Name         Type    Description
  #     description  String  A text description.
  #     public_key   String  The public key.
  #     fingerprint  String  The fingerprint.
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #     Name         Type    Description
  #     description  String  A text description.
  #     public_key   String  The public key.
  #     fingerprint  String  The fingerprint.
  #
  # ## Actions
  #
  # **Find**
  #
  # Return the current key pair.
  #
  # GET <code>/repo/{repository.id}/key_pair/generated</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /repo/891/key_pair/generated
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.api_endpoint = 'https://api.travis-ci.com'
  # travis.authorization = 'xxxx'
  # travis.key_pair_generated
  # ```
  #
  # GET <code>/repo/{repository.slug}/key_pair/generated</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /repo/rails%2Frails/key_pair/generated
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.api_endpoint = 'https://api.travis-ci.com'
  # travis.authorization = 'xxxx'
  # travis.key_pair_generated
  # ```
  #
  # **Create**
  #
  # Generate a new key pair, replacing the previous one.
  #
  # POST <code>/repo/{repository.id}/key_pair/generated</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #
  #     Example: POST /repo/891/key_pair/generated
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.api_endpoint = 'https://api.travis-ci.com'
  # travis.authorization = 'xxxx'
  # travis.key_pair_generated(:create)
  # ```
  #
  # POST <code>/repo/{repository.slug}/key_pair/generated</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #
  #     Example: POST /repo/rails%2Frails/key_pair/generated
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.api_endpoint = 'https://api.travis-ci.com'
  # travis.authorization = 'xxxx'
  # travis.key_pair_generated(:create)
  # ```
  #
  # @note requests require an authorization token set in the headers. See: {authorization=}
  #
  # @param action [String, Symbol] defaults to getting current key pair, use `:create` if you would like to generate a new key pair
  # @return [Success, RequestError]
  def key_pair_generated(action = :get)
    return post("#{with_repo}/key_pair/generated") if action.match?(/create/i)

    get("#{with_repo}/key_pair/generated")
  end

  # This validates the `.travis.yml` file and returns any warnings.
  #
  # The request body can contain the content of the .travis.yml file directly as a string, eg "foo: bar".
  #
  # ## Attributes
  #
  #     Name      Type   Description
  #     warnings  Array  An array of hashes with keys and warnings.
  #
  # ## Actions
  #
  # **Lint**
  #
  # POST <code>/lint</code>
  #
  #     Example: POST /lint
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.lint(File.read('.travis.yml'))
  # ```
  #
  # @param yaml_content [String] the contents for the file `.travis.yml`
  # @return [Success, RequestError]
  def lint(yaml_content)
    validate_string yaml_content

    ct = headers.remove(:'Content-Type')
    result = post("#{without_repo}/lint", yaml_content)
    h('Content-Type': ct) if ct
    result
  end

  # An individual log.
  #
  # ## Attributes
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #     Name  Type     Description
  #     id    Unknown  The log's id.
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is eager loaded.
  #
  #     Name       Type     Description
  #     id         Unknown  The log's id.
  #     content    Unknown  The log's content.
  #     log_parts  Unknown  The log's log_parts.
  #
  # ## Actions
  #
  # **Find**
  #
  # This returns a single log.
  #
  # It's possible to specify the accept format of the request as text/plain if required. This will return the content of the log as a single blob of text.
  #
  #     curl -H "Travis-API-Version: 3" \
  #       -H "Accept: text/plain" \
  #       -H "Authorization: token xxxxxxxxxxxx" \
  #       https://api.travis-ci.org/job/{job.id}/log
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.log(351_778_875)
  # # or
  # travis.log(351_778_875, :text)
  # ```
  #
  # The default response type is application/json, and will include additional meta data such as @type, @representation etc. (see [https://developer.travis-ci.org/format](https://developer.travis-ci.org/format)).
  #
  # GET <code>/job/{job.id}/log</code>
  #
  #     Template Variable  Type     Description
  #     job.id             Integer  Value uniquely identifying the job.
  #
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #     log.token        Unknown   Documentation missing.
  #
  #     Example: GET /job/86601347/log
  #
  # GET <code>/job/{job.id}/log.txt</code>
  #
  #     Template Variable  Type     Description
  #     job.id             Integer  Value uniquely identifying the job.
  #
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #     log.token        Unknown   Documentation missing.
  #
  #     Example: GET /job/86601347/log.txt
  #
  # **Delete**
  #
  # This removes the contents of a log. It gets replace with the message: Log removed by XXX at 2017-02-13 16:00:00 UTC.
  #
  #     curl -X DELETE \
  #       -H "Travis-API-Version: 3" \
  #       -H "Authorization: token xxxxxxxxxxxx" \
  #       https://api.travis-ci.org/job/{job.id}/log
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.log(478_772_530, :delete)
  # ```
  #
  # DELETE <code>/job/{job.id}/log</code>
  #
  #     Template Variable  Type     Description
  #     job.id             Integer  Value uniquely identifying the job.
  #
  #     Example: DELETE /job/86601347/log
  #
  # @param job_id [String, Integer] the job id number
  # @param option [Symbol] options for :text or :delete
  # @return [Success, String, RequestError]
  def log(job_id, option = nil)
    case option
    when :text
      get("#{without_repo}/job/#{job_id}/log.txt", true)
    when :delete
      delete("#{without_repo}/job/#{job_id}/log")
    else
      get("#{without_repo}/job/#{job_id}/log")
    end
  end

  # A list of messages. Messages belong to resource types.
  #
  # ## Attributes
  #
  #     Name      Type       Description
  #     messages  [Message]  List of messages.
  #
  # **Collection Items**
  #
  # Each entry in the messages array has the following attributes:
  #
  #     Name   Type     Description
  #     id     Integer  The message's id.
  #     level  String   The message's level.
  #     key    String   The message's key.
  #     code   String   The message's code.
  #     args   Json     The message's args.
  #
  # ## Actions
  #
  # **For Request**
  #
  # This will return a list of messages created by `travis-yml` for a request, if any exist.
  #
  # GET <code>/repo/{repository.id}/request/{request.id}/messages</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     request.id         Integer  Value uniquely identifying the request.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #     limit            Integer   How many messages to include in the response. Used for pagination.
  #     offset           Integer   How many messages to skip before the first entry in the response. Used for pagination.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.messages(147_731_561)
  # ```
  #
  # GET <code>/repo/{repository.slug}/request/{request.id}/messages</code>
  #
  #     Template Variable  Type     Description
  #     repository.slug    String   Same as {repository.owner.name}/{repository.name}.
  #     request.id         Integer  Value uniquely identifying the request.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #     limit            Integer   How many messages to include in the response. Used for pagination.
  #     offset           Integer   How many messages to skip before the first entry in the response. Used for pagination.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.messages(147_731_561)
  # ```
  #
  # @param request_id [String, Integer] the request id
  # @return [Success, RequestError]
  def messages(request_id)
    validate_number request_id

    get("#{with_repo}/request/#{request_id}/messages")
  end

  # An individual organization.
  #
  # ## Attributes
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #     Name   Type     Description
  #     id     Integer  Value uniquely identifying the organization.
  #     login  String   Login set on GitHub.
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is {https://developer.travis-ci.com/eager-loading eager loaded}.
  #
  #     Name             Type     Description
  #     id               Integer  Value uniquely identifying the organization.
  #     login            String   Login set on GitHub.
  #     name             String   Name set on GitHub.
  #     github_id        Integer  Id set on GitHub.
  #     avatar_url       String   Avatar_url set on GitHub.
  #     education        Boolean  Whether or not the organization has an education account.
  #     allow_migration  Unknown  The organization's allow_migration.
  #
  # **Additional Attributes**
  #
  #     Name          Type          Description
  #     repositories  [Repository]  Repositories belonging to this organization.
  #     installation  Installation  Installation belonging to the organization.
  #
  # ## Actions
  #
  # **Find**
  #
  # This returns an individual organization.
  #
  # GET <code>/org/{organization.id}</code>
  #
  #     Template Variable  Type      Description
  #     organization.id    Integer   Value uniquely identifying the organization.
  #     Query Parameter    Type      Description
  #     include            [String]  List of attributes to eager load.
  #
  #     Example: GET /org/87
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.organization(87)
  # ```
  #
  # @param org_id [String, Integer] the organization id
  # @raise [TypeError] if given organization id is not a number
  # @return [Success, RequestError]
  def organization(org_id)
    validate_number org_id

    get("#{without_repo}/org/#{org_id}")
  end

  # A list of organizations for the current user.
  #
  # ## Attributes
  #
  #     Name           Type            Description
  #     organizations  [Organization]  List of organizations.
  #
  # **Collection Items**
  #
  # Each entry in the **organizations** array has the following attributes:
  #
  #     Name             Type          Description
  #     id               Integer       Value uniquely identifying the organization.
  #     login            String        Login set on GitHub.
  #     name             String        Name set on GitHub.
  #     github_id        Integer       Id set on GitHub.
  #     avatar_url       String        Avatar_url set on GitHub.
  #     education        Boolean       Whether or not the organization has an education account.
  #     allow_migration  Unknown       The organization's allow_migration.
  #     repositories     [Repository]  Repositories belonging to this organization.
  #     installation     Installation  Installation belonging to the organization.
  #
  # ## Actions
  #
  # **For Current User**
  #
  # This returns a list of organizations the current user is a member of.
  #
  # GET <code>/orgs</code>
  #
  #     Query Parameter    Type      Description
  #     include            [String]  List of attributes to eager load.
  #     limit              Integer   How many organizations to include in the response. Used for pagination.
  #     offset             Integer   How many organizations to skip before the first entry in the response. Used for pagination.
  #     organization.role  Unknown   Documentation missing.
  #     role               Unknown   Alias for organization.role.
  #     sort_by            [String]  Attributes to sort organizations by. Used for pagination.
  #
  #     Example: GET /orgs?limit=5
  #
  # **Sortable by:** <code>id</code>, <code>login</code>, <code>name</code>, <code>github_id</code>, append <code>:desc</code> to any attribute to reverse order.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.options.build({limit: 5})
  # travis.organizations
  # ```
  #
  # @return [Success, RequestError]
  def organizations
    get("#{without_repo}/orgs#{opts}")
  end

  # This will be either a {https://developer.travis-ci.com/resource/user user} or {https://developer.travis-ci.com/resource/organization organization}.
  #
  # ## Attributes
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #     Name    Type     Description
  #     id      Integer  Value uniquely identifying the owner.
  #     login   String   User or organization login set on GitHub.
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is {https://developer.travis-ci.com/eager-loading eager loaded}.
  #
  #     Name        Type     Description
  #     id          Integer  Value uniquely identifying the owner.
  #     login       String   User or organization login set on GitHub.
  #     name        String   User or organization name set on GitHub.
  #     github_id   Integer  User or organization id set on GitHub.
  #     avatar_url  String   Link to user or organization avatar (image) set on GitHub.
  #
  # **Additional Attributes**
  #
  #     Name           Type           Description
  #     repositories   [Repository]   Repositories belonging to this account.
  #
  # ## Actions
  #
  # **Find**
  #
  # This returns an individual owner. It is possible to use the GitHub login or github_id in the request.
  #
  # GET <code>/owner/{owner.login}</code>
  #
  #     Template Variable  Type      Description
  #     owner.login        String    User or organization login set on GitHub.
  #
  #     Query Parameter    Type      Description
  #     include            [String]  List of attributes to eager load.
  #
  #     Example: GET /owner/danielpclark
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.owner
  # # or
  # travis.owner('danielpclark')
  # ```
  #
  # GET <code>/owner/{user.login}</code>
  #
  #     Template Variable  Type      Description
  #     user.login         String    Login set on GitHub.
  #
  #     Query Parameter    Type      Description
  #     include            [String]  List of attributes to eager load.
  #
  #     Example: GET /owner/danielpclark
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.owner
  # # or
  # travis.owner('danielpclark')
  # ```
  #
  # GET <code>/owner/{organization.login}</code>
  #
  #     Template Variable   Type      Description
  #     organization.login  String    Login set on GitHub.
  #
  #     Query Parameter     Type      Description
  #     include             [String]  List of attributes to eager load.
  #
  #     Example: GET /owner/travis-ci
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.owner('travis-ci')
  # ```
  #
  # GET <code>/owner/github_id/{owner.github_id}</code>
  #
  #     Template Variable   Type      Description
  #     owner.github_id     Integer   User or organization id set on GitHub.
  #
  #     Query Parameter     Type      Description
  #     include             [String]  List of attributes to eager load.
  #
  #     Example: GET /owner/github_id/639823
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.owner(639_823)
  # ```
  #
  # @param owner [String] username or github id
  # @return [Success, RequestError]
  def owner(owner = username)
    number?(owner) and return get("#{without_repo}/owner/github_id/#{owner}")
    get("#{without_repo}/owner/#{owner}")
  end

  # Individual preferences for current user or organization.
  #
  # ## Attributes
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is {https://developer.travis-ci.com/eager-loading eager loaded}.
  #
  #     Name   Type     Description
  #     name   Unknown  The preference's name.
  #     value  Unknown  The preference's value.
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #     Name   Type     Description
  #     name   Unknown  The preference's name.
  #     value  Unknown  The preference's value.
  #
  # ## Actions
  #
  # **For Organization**
  #
  # Get preference for organization.
  #
  # GET <code>/org/{organization.id}/preference/{preference.name}</code>
  #
  #     Template Variable  Type     Description
  #     organization.id    Integer  Value uniquely identifying the organization.
  #     preference.name    Unknown  The preference's name.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.preference('private_insights_visibility', org_id: 107_660)
  # ```
  #
  # **Update**
  #
  # Set preference for organization.
  #
  # PATCH <code>/org/{organization.id}/preference/{preference.name}</code>
  #
  #     Template Variable  Type     Description
  #     organization.id    Integer  Value uniquely identifying the organization.
  #     preference.name    Unknown  The preference's name.
  #     Accepted Parameter  Type     Description
  #     preference.value    Unknown  The preference's value.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.preference('private_insights_visibility', 'admins', org_id: 107_660)
  # ```
  #
  # Set preference for current user.
  #
  # PATCH <code>/preference/{preference.name}</code>
  #
  #     Template Variable  Type     Description
  #     preference.name    Unknown  The preference's name.
  #     Accepted Parameter  Type     Description
  #     preference.value    Unknown  The preference's value.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.preference('build_emails', true)
  # ```
  #
  # **Find**
  #
  # Get preference for current user.
  #
  # GET <code>/preference/{preference.name}</code>
  #
  #     Template Variable  Type     Description
  #     preference.name    Unknown  The preference's name.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.preference('build_emails')
  # ```
  #
  # @note requests require an authorization token set in the headers. See: {authorization=}
  #
  # @param key [String] preference name to get or set
  # @param value [String] optional value to set preference
  # @param org_id [String, Integer] optional keyword argument for an organization id
  # @return [Success, RequestError]
  def preference(key, value = nil, org_id: nil)
    if org_id
      validate_number org_id
      org_id = "/org/#{org_id}"
    end

    value and return patch("#{without_repo}#{org_id}/preference/#{key}", 'preference.value' => value)
    get("#{without_repo}#{org_id}/preference/#{key}")
  end

  # Preferences for current user or organization.
  #
  # ## Attributes
  #
  #     Name         Type         Description
  #     preferences  [Preferenc]  List of preferences.
  #
  # ## Actions
  #
  # **For Organization**
  #
  # Gets preferences for organization.
  #
  # GET <code>/org/{organization.id}/preferences</code>
  #
  #     Template Variable  Type     Description
  #     organization.id    Integer  Value uniquely identifying the organization.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /org/87/preferences
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.preferences(107_660)
  # ```
  #
  # **For User**
  #
  # Gets preferences for current user.
  #
  # GET <code>/preferences</code>
  #
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /preferences
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.preferences
  # ```
  #
  # @note requests require an authorization token set in the headers. See: {authorization=}
  #
  # @param org_id [String, Integer] optional organization id
  # @return [Success, RequestError]
  def preferences(org_id = nil)
    if org_id
      validate_number org_id
      org_id = "/org/#{org_id}"
    end

    get("#{without_repo}#{org_id}/preferences")
  end

  # A list of repositories for the current user.
  #
  # ## Attributes
  #
  #     Name           Type           Description
  #     repositories   [Repository]   List of repositories.
  #
  # **Collection Items**
  #
  # Each entry in the repositories array has the following attributes:
  #
  #     Name                Type     Description
  #     id                  Integer  Value uniquely identifying the repository.
  #     name                String   The repository's name on GitHub.
  #     slug                String   Same as {repository.owner.name}/{repository.name}.
  #     description         String   The repository's description from GitHub.
  #     github_language     String   The main programming language used according to GitHub.
  #     active              Boolean  Whether or not this repository is currently enabled on Travis CI.
  #     private             Boolean  Whether or not this repository is private.
  #     owner               Owner    GitHub user or organization the repository belongs to.
  #     default_branch      Branch   The default branch on GitHub.
  #     starred             Boolean  Whether or not this repository is starred.
  #     current_build       Build    The most recently started build (this excludes builds that have been created but have not yet started).
  #     last_started_build  Build    Alias for current_build.
  #
  # ## Actions
  #
  # **For Owner**
  #
  # This returns a list of repositories an owner has access to.
  #
  # GET <code>/owner/{owner.login}/repos</code>
  #
  #     Template Variable  Type    Description
  #     owner.login        String  User or organization login set on GitHub.
  #
  #     Query Parameter     Type       Description
  #     active              [Boolean]  Alias for repository.active.
  #     include             [String]   List of attributes to eager load.
  #     limit               Integer    How many repositories to include in the response. Used for pagination.
  #     offset              Integer    How many repositories to skip before the first entry in the response. Used for pagination.
  #     private             [Boolean]  Alias for repository.private.
  #     repository.active   [Boolean]  Filters repositories by whether or not this repository is currently enabled on Travis CI.
  #     repository.private  [Boolean]  Filters repositories by whether or not this repository is private.
  #     repository.starred  [Boolean]  Filters repositories by whether or not this repository is starred.
  #     sort_by             [String]   Attributes to sort repositories by. Used for pagination.
  #     starred             [Boolean]  Alias for repository.starred.
  #
  #     Example: GET /owner/danielpclark/repos?limit=5&sort_by=active,name
  #
  # **Sortable by:** <code>id</code>, <code>github_id</code>, <code>owner_name</code>, <code>name</code>, <code>active</code>, <code>default_branch.last_build</code>, append <code>:desc</code> to any attribute to reverse order.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.options.build({limit: 5, sort_by: 'active,name'})
  # travis.repositories
  # # or
  # travis.repositories('danielpclark')
  # ```
  #
  # GET <code>/owner/{user.login}/repos</code>
  #
  #     Template Variable  Type    Description
  #     user.login         String  Login set on GitHub.
  #
  #     Query Parameter     Type       Description
  #     active              [Boolean]  Alias for repository.active.
  #     include             [String]   List of attributes to eager load.
  #     limit               Integer    How many repositories to include in the response. Used for pagination.
  #     offset              Integer    How many repositories to skip before the first entry in the response. Used for pagination.
  #     private             [Boolean]  Alias for repository.private.
  #     repository.active   [Boolean]  Filters repositories by whether or not this repository is currently enabled on Travis CI.
  #     repository.private  [Boolean]  Filters repositories by whether or not this repository is private.
  #     repository.starred  [Boolean]  Filters repositories by whether or not this repository is starred.
  #     sort_by             [String]   Attributes to sort repositories by. Used for pagination.
  #     starred             [Boolean]  Alias for repository.starred.
  #
  #     Example: GET /owner/danielpclark/repos?limit=5&sort_by=active,name
  #
  # **Sortable by:** <code>id</code>, <code>github_id</code>, <code>owner_name</code>, <code>name</code>, <code>active</code>, <code>default_branch.last_build</code>, append <code>:desc</code> to any attribute to reverse order.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.options.build({limit: 5, sort_by: 'active,name'})
  # travis.repositories
  # # or
  # travis.repositories('danielpclark')
  # ```
  #
  # GET <code>/owner/{organization.login}/repos</code>
  #
  #     Template Variable   Type    Description
  #     organization.login  String  Login set on GitHub.
  #
  #     Query Parameter     Type       Description
  #     active              [Boolean]  Alias for repository.active.
  #     include             [String]   List of attributes to eager load.
  #     limit               Integer    How many repositories to include in the response. Used for pagination.
  #     offset              Integer    How many repositories to skip before the first entry in the response. Used for pagination.
  #     private             [Boolean]  Alias for repository.private.
  #     repository.active   [Boolean]  Filters repositories by whether or not this repository is currently enabled on Travis CI.
  #     repository.private  [Boolean]  Filters repositories by whether or not this repository is private.
  #     repository.starred  [Boolean]  Filters repositories by whether or not this repository is starred.
  #     sort_by             [String]   Attributes to sort repositories by. Used for pagination.
  #     starred             [Boolean]  Alias for repository.starred.
  #
  #     Example: GET /owner/travis-ci/repos?limit=5&sort_by=active,name
  #
  # **Sortable by:** <code>id</code>, <code>github_id</code>, <code>owner_name</code>, <code>name</code>, <code>active</code>, <code>default_branch.last_build</code>, append <code>:desc</code> to any attribute to reverse order.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.options.build({limit: 5, sort_by: 'active,name'})
  # travis.repositories('travis-ci')
  # ```
  #
  # GET <code>/owner/github_id/{owner.github_id}/repos</code>
  #
  #     Template Variable  Type     Description
  #     owner.github_id    Integer  User or organization id set on GitHub.
  #
  #     Query Parameter     Type       Description
  #     active              [Boolean]  Alias for repository.active.
  #     include             [String]   List of attributes to eager load.
  #     limit               Integer    How many repositories to include in the response. Used for pagination.
  #     offset              Integer    How many repositories to skip before the first entry in the response. Used for pagination.
  #     private             [Boolean]  Alias for repository.private.
  #     repository.active   [Boolean]  Filters repositories by whether or not this repository is currently enabled on Travis CI.
  #     repository.private  [Boolean]  Filters repositories by whether or not this repository is private.
  #     repository.starred  [Boolean]  Filters repositories by whether or not this repository is starred.
  #     sort_by             [String]   Attributes to sort repositories by. Used for pagination.
  #     starred             [Boolean]  Alias for repository.starred.
  #
  #     Example: GET /owner/github_id/639823/repos?limit=5&sort_by=active,name
  #
  # **Sortable by:** <code>id</code>, <code>github_id</code>, <code>owner_name</code>, <code>name</code>, <code>active</code>, <code>default_branch.last_build</code>, append <code>:desc</code> to any attribute to reverse order.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.options.build({limit: 5, sort_by: 'active,name'})
  # travis.repositories(639_823)
  # ```
  #
  # **For Current User**
  #
  # This returns a list of repositories the current user has access to.
  #
  # GET <code>/repos</code>
  #
  #     Query Parameter     Type       Description
  #     active              [Boolean]  Alias for repository.active.
  #     include             [String]   List of attributes to eager load.
  #     limit               Integer    How many repositories to include in the response. Used for pagination.
  #     offset              Integer    How many repositories to skip before the first entry in the response. Used for pagination.
  #     private             [Boolean]  Alias for repository.private.
  #     repository.active   [Boolean]  Filters repositories by whether or not this repository is currently enabled on Travis CI.
  #     repository.private  [Boolean]  Filters repositories by whether or not this repository is private.
  #     repository.starred  [Boolean]  Filters repositories by whether or not this repository is starred.
  #     sort_by             [String]   Attributes to sort repositories by. Used for pagination.
  #     starred             [Boolean]  Alias for repository.starred.
  #
  #     Example: GET /repos?limit=5&sort_by=active,name
  #
  # **Sortable by:** <code>id</code>, <code>github_id</code>, <code>owner_name</code>, <code>name</code>, <code>active</code>, <code>default_branch.last_build</code>, append <code>:desc</code> to any attribute to reverse order.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.options.build({limit: 5, sort_by: 'active,name'})
  # travis.repositories(:self)
  # ```
  #
  # @param owner [String, Integer, Symbol] username, github id, or `:self`
  # @return [Success, RequestError]
  def repositories(owner = username)
    owner.equal?(:self) and return get("#{without_repo}/repos#{opts}")
    number?(owner) and return get("#{without_repo}/owner/github_id/#{owner}/repos#{opts}")
    get("#{without_repo}/owner/#{owner}/repos#{opts}")
  end

  # An individual repository.
  #
  # ## Attributes
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #     Name   Type     Description
  #     id     Integer  Value uniquely identifying the repository.
  #     name   String   The repository's name on GitHub.
  #     slug   String   Same as {repository.owner.name}/{repository.name}.
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is eager loaded.
  #
  #     Name             Type     Description
  #     id               Integer  Value uniquely identifying the repository.
  #     name             String   The repository's name on GitHub.
  #     slug             String   Same as {repository.owner.name}/{repository.name}.
  #     description      String   The repository's description from GitHub.
  #     github_language  String   The main programming language used according to GitHub.
  #     active           Boolean  Whether or not this repository is currently enabled on Travis CI.
  #     private          Boolean  Whether or not this repository is private.
  #     owner            Owner    GitHub user or organization the repository belongs to.
  #     default_branch   Branch   The default branch on GitHub.
  #     starred          Boolean  Whether or not this repository is starred.
  #
  # ## Actions
  #
  # **Find**
  #
  # This returns an individual repository.
  #
  # GET <code>/repo/{repository.id}</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /repo/891
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.repository('danielpclark/trav3')
  # ```
  #
  # GET <code>/repo/{repository.slug}</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /repo/rails%2Frails
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.repository('danielpclark/trav3')
  # ```
  #
  # **Activate**
  #
  # This will activate a repository, allowing its tests to be run on Travis CI.
  #
  # POST <code>/repo/{repository.id}/activate</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #
  #     Example: POST /repo/891/activate
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.repository('danielpclark/trav3', :activate)
  # ```
  #
  # POST <code>/repo/{repository.slug}/activate</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #
  #     Example: POST /repo/rails%2Frails/activate
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.repository('danielpclark/trav3', :activate)
  # ```
  #
  # **Deactivate**
  #
  # This will deactivate a repository, preventing any tests from running on Travis CI.
  #
  # POST <code>/repo/{repository.id}/deactivate</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #
  #     Example: POST /repo/891/deactivate
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.repository('danielpclark/trav3', :deactivate)
  # ```
  #
  # POST <code>/repo/{repository.slug}/deactivate</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #
  #     Example: POST /repo/rails%2Frails/deactivate
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.repository('danielpclark/trav3', :deactivate)
  # ```
  #
  # **Star**
  #
  # This will star a repository based on the currently logged in user.
  #
  # POST <code>/repo/{repository.id}/star</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #
  #     Example: POST /repo/891/star
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.repository('danielpclark/trav3', :star)
  # ```
  #
  # POST <code>/repo/{repository.slug}/star</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #
  #     Example: POST /repo/rails%2Frails/star
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.repository('danielpclark/trav3', :star)
  # ```
  #
  # **Unstar**
  #
  # This will unstar a repository based on the currently logged in user.
  #
  # POST <code>/repo/{repository.id}/unstar</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #
  #     Example: POST /repo/891/unstar
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.repository('danielpclark/trav3', :unstar)
  # ```
  #
  # POST <code>/repo/{repository.slug}/unstar</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #
  #     Example: POST /repo/rails%2Frails/unstar
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.repository('danielpclark/trav3', :unstar)
  # ```
  #
  # @note POST requests require an authorization token set in the headers. See: {authorization=}
  #
  # @param repo [String] github_username/repository_name
  # @param action [String, Symbol] Optional argument for star/unstar/activate/deactivate
  # @raise [InvalidRepository] if given input does not
  #   conform to valid repository identifier format
  # @return [Success, RequestError]
  def repository(repo = repository_name, action = nil)
    validate_repo_format repo

    repo = sanitize_repo_name repo

    action and return post("#{without_repo}/repo/#{repo}/#{action}")
    get("#{without_repo}/repo/#{repo}")
  end

  # An individual request
  #
  # ## Attributes
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #     Name     Type     Description
  #     id       Integer  Value uniquely identifying the request.
  #     state    String   The state of a request (eg. whether it has been processed or not).
  #     result   String   The result of the request (eg. rejected or approved).
  #     message  String   Travis-ci status message attached to the request.
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is {https://developer.travis-ci.com/eager-loading eager loaded}.
  #
  #     Name         Type        Description
  #     id           Integer     Value uniquely identifying the request.
  #     state        String      The state of a request (eg. whether it has been processed or not).
  #     result       String      The result of the request (eg. rejected or approved).
  #     message      String      Travis-ci status message attached to the request.
  #     repository   Repository  GitHub user or organization the request belongs to.
  #     branch_name  String      Name of the branch requested to be built.
  #     commit       Commit      The commit the request is associated with.
  #     builds       [Build]     The request's builds.
  #     owner        Owner       GitHub user or organization the request belongs to.
  #     created_at   String      When Travis CI created the request.
  #     event_type   String      Origin of request (push, pull request, api).
  #     base_commit  String      The base commit the request is associated with.
  #     head_commit  String      The head commit the request is associated with.
  #
  # ## Actions
  #
  # **Find**
  #
  # Get the request by id for the current repository
  #
  # GET <code>/repo/{repository.id}/request/{request.id}</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     request.id         Integer  Value uniquely identifying the request.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.request(147_776_757)
  # ```
  #
  # GET <code>/repo/{repository.slug}/request/{request.id}</code>
  #
  #     Template Variable  Type     Description
  #     repository.slug    String   Same as {repository.owner.name}/{repository.name}.
  #     request.id         Integer  Value uniquely identifying the request.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.request(147_776_757)
  # ```
  #
  # @param request_id [String, Integer] request id
  # @return [Success, RequestError]
  def request(request_id)
    validate_number request_id

    get("#{with_repo}/request/#{request_id}")
  end

  # A list of requests.
  #
  # If querying using the repository slug, it must be formatted using {http://www.w3schools.com/tags/ref_urlencode.asp standard URL encoding}, including any special characters.
  #
  # ## Attributes
  #
  #     Name      Type       Description
  #     requests  [Request]  List of requests.
  #
  # **Collection Items**
  #
  # Each entry in the **requests** array has the following attributes:
  #
  #     Name         Type        Description
  #     id           Integer     Value uniquely identifying the request.
  #     state        String      The state of a request (eg. whether it has been processed or not).
  #     result       String      The result of the request (eg. rejected or approved).
  #     message      String      Travis-ci status message attached to the request.
  #     repository   Repository  GitHub user or organization the request belongs to.
  #     branch_name  String      Name of the branch requested to be built.
  #     commit       Commit      The commit the request is associated with.
  #     builds       [Build]     The request's builds.
  #     owner        Owner       GitHub user or organization the request belongs to.
  #     created_at   String      When Travis CI created the request.
  #     event_type   String      Origin of request (push, pull request, api).
  #     base_commit  String      The base commit the request is associated with.
  #     head_commit  String      The head commit the request is associated with.
  #     yaml_config  Unknown     The request's yaml_config.
  #
  # ## Actions
  #
  # **Find**
  #
  # This will return a list of requests belonging to a repository.
  #
  # GET <code>/repo/{repository.id}/requests</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #     limit            Integer   How many requests to include in the response. Used for pagination.
  #     offset           Integer   How many requests to skip before the first entry in the response. Used for pagination.
  #
  #     Example: GET /repo/891/requests?limit=5
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.options.build({limit: 5})
  # travis.requests
  # ```
  #
  # GET <code>/repo/{repository.slug}/requests</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #     limit            Integer   How many requests to include in the response. Used for pagination.
  #     offset           Integer   How many requests to skip before the first entry in the response. Used for pagination.
  #
  #     Example: GET /repo/rails%2Frails/requests?limit=5
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.options.build({limit: 5})
  # travis.requests
  # ```
  #
  # **Create**
  #
  # This will create a request for an individual repository, triggering a build to run on Travis CI.
  #
  # Use namespaced params in JSON format in the request body to pass any accepted parameters. Any keys in the request's config will override keys existing in the `.travis.yml`.
  #
  # ```bash
  # curl -X POST \
  #   -H "Content-Type: application/json" \
  #   -H "Travis-API-Version: 3" \
  #   -H "Authorization: token xxxxxxxxxxxx" \
  #   -d '{ "request": {
  #         "message": "Override the commit message: this is an api request", "branch": "master" }}'\
  #   https://api.travis-ci.com/repo/1/requests
  # ```
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.requests(
  #   message: 'Override the commit message: this is an api request',
  #   branch: 'master'
  # )
  # ```
  #
  # The response includes the following body:
  #
  # ```json
  # {
  #   "@type":              "pending",
  #   "remaining_requests": 1,
  #   "repository":         {
  #     "@type":            "repository",
  #     "@href":            "/repo/1",
  #     "@representation":  "minimal",
  #     "id":               1,
  #     "name":             "test",
  #     "slug":             "owner/repo"
  #   },
  #   "request":            {
  #     "repository":       {
  #       "id":             1,
  #       "owner_name":     "owner",
  #       "name":           "repo"
  #     },
  #     "user":             {
  #       "id":             1
  #     },
  #     "id":               1,
  #     "message":          "Override the commit message: this is an api request",
  #     "branch":           "master",
  #     "config":           { }
  #   },
  #   "resource_type":      "request"
  # }
  # ```
  #
  # POST <code>/repo/{repository.id}/requests</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     Accepted Parameter  Type    Description
  #     request.config      String  Build configuration (as parsed from .travis.yml).
  #     request.message     String  Travis-ci status message attached to the request.
  #     request.branch      String  Branch requested to be built.
  #     request.token       Object  Travis token associated with webhook on GitHub (DEPRECATED).
  #
  #     Example: POST /repo/891/requests
  #
  # POST <code>/repo/{repository.slug}/requests</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     Accepted Parameter  Type    Description
  #     request.config      String  Build configuration (as parsed from .travis.yml).
  #     request.message     String  Travis-ci status message attached to the request.
  #     request.branch      String  Branch requested to be built.
  #     request.token       Object  Travis token associated with webhook on GitHub (DEPRECATED).
  #
  #     Example: POST /repo/rails%2Frails/requests
  #
  # @param attributes [Hash] request attributes
  # @return [Success, RequestError]
  def requests(**attributes)
    return get("#{with_repo}/requests") if attributes.empty?

    create("#{with_repo}/requests", 'request': attributes)
  end

  # A list of stages.
  #
  # Currently this is nested within a build.
  #
  # ## Attributes
  #
  #     Name    Type     Description
  #     stages  [Stage]  List of stages.
  #
  # **Collection Items**
  #
  # Each entry in the stages array has the following attributes:
  #
  #     Name         Type     Description
  #     id           Integer  Value uniquely identifying the stage.
  #     number       Integer  Incremental number for a stage.
  #     name         String   The name of the stage.
  #     state        String   Current state of the stage.
  #     started_at   String   When the stage started.
  #     finished_at  String   When the stage finished.
  #     jobs         [Job]    The jobs of a stage.
  #
  # ## Actions
  #
  # **Find**
  #
  # This returns a list of stages belonging to an individual build.
  #
  # GET <code>/build/{build.id}/stages</code>
  #
  #     Template Variable  Type     Description
  #     build.id           Integer  Value uniquely identifying the build.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /build/86601346/stages
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.stages(479_113_572)
  # ```
  #
  # @param build_id [String, Integer] build id
  # @raise [TypeError] if given build id is not a number
  # @return [Success, RequestError]
  def stages(build_id)
    validate_number build_id

    get("#{without_repo}/build/#{build_id}/stages")
  end

  # An individual repository setting. These are settings on a repository that can be adjusted by the user. There are currently five different kinds of settings a user can modify:
  #
  # * `builds_only_with_travis_yml` (boolean)
  # * `build_pushes` (boolean)
  # * `build_pull_requests` (boolean)
  # * `maximum_number_of_builds` (integer)
  # * `auto_cancel_pushes` (boolean)
  # * `auto_cancel_pull_requests` (boolean)
  #
  # If querying using the repository slug, it must be formatted using {http://www.w3schools.com/tags/ref_urlencode.asp standard URL encoding}, including any special characters.
  #
  # ## Attributes
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is {https://developer.travis-ci.com/eager-loading eager loaded}.
  #
  #     Name   Type                Description
  #     name   String              The setting's name.
  #     value  Boolean or integer  The setting's value.
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #   Name   Type                Description
  #   name   String              The setting's name.
  #   value  Boolean or integer  The setting's value.
  #
  # ## Actions
  #
  # **Find**
  #
  # This returns a single setting. It is possible to use the repository id or slug in the request.
  #
  # GET <code>/repo/{repository.id}/setting/{setting.name}</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     setting.name       String   The setting's name.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.setting('auto_cancel_pull_requests')
  # ```
  #
  # GET <code>/repo/{repository.slug}/setting/{setting.name}</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     setting.name       String  The setting's name.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.setting('auto_cancel_pull_requests')
  # ```
  #
  # **Update**
  #
  # This updates a single setting. It is possible to use the repository id or slug in the request.
  #
  # Use namespaced params in the request body to pass the new setting:
  #
  # ```bash
  # curl -X PATCH \
  #   -H "Content-Type: application/json" \
  #   -H "Travis-API-Version: 3" \
  #   -H "Authorization: token xxxxxxxxxxxx" \
  #   -d '{ "setting.value": true }' \
  #   https://api.travis-ci.com/repo/1234/setting/{setting.name}
  # ```
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.setting('auto_cancel_pull_requests', false)
  # ```
  #
  # PATCH <code>/repo/{repository.id}/setting/{setting.name}</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     setting.name       String   The setting's name.
  #     Accepted Parameter  Type                Description
  #     setting.value       Boolean or integer  The setting's value.
  #
  # PATCH <code>/repo/{repository.slug}/setting/{setting.name}</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     setting.name       String  The setting's name.
  #     Accepted Parameter  Type                Description
  #     setting.value       Boolean or integer  The setting's value.
  #
  # @param name [String] the setting name for the current repository
  # @param value [String] optional argument for setting a value for the setting name
  # @return [Success, RequestError]
  def setting(name, value = nil)
    return get("#{with_repo}/setting/#{name}") if value.nil?

    patch("#{with_repo}/setting/#{name}", 'setting.value' => value)
  end

  # A list of user settings. These are settings on a repository that can be adjusted by the user. There are currently six different kinds of user settings:
  #
  # * `builds_only_with_travis_yml` (boolean)
  # * `build_pushes` (boolean)
  # * `build_pull_requests` (boolean)
  # * `maximum_number_of_builds` (integer)
  # * `auto_cancel_pushes` (boolean)
  # * `auto_cancel_pull_requests` (boolean)
  #
  # If querying using the repository slug, it must be formatted using {http://www.w3schools.com/tags/ref_urlencode.asp standard URL encoding}, including any special characters.
  #
  # ## Attributes
  #
  #     Name      Type       Description
  #     settings  [Setting]  List of settings.
  #
  # **Collection Items**
  #
  # Each entry in the settings array has the following attributes:
  #
  #     Name   Type                Description
  #     name   String              The setting's name.
  #     value  Boolean or integer  The setting's value.
  #
  # ## Actions
  #
  # **For Repository**
  #
  # This returns a list of the settings for that repository. It is possible to use the repository id or slug in the request.
  #
  # GET <code>/repo/{repository.id}/settings</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /repo/891/settings
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.settings
  # ```
  #
  # GET <code>/repo/{repository.slug}/settings</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /repo/rails%2Frails/settings
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.settings
  # ```
  #
  # @return [Success, RequestError]
  def settings
    get("#{with_repo}/settings")
  end

  # An individual user.
  #
  # ## Attributes
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #     Name  Type     Description
  #     id    Integer  Value uniquely identifying the user.
  #     login String   Login set on GitHub.
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is {https://developer.travis-ci.com/eager-loading eager loaded}.
  #
  #     Name              Type     Description
  #     id                Integer  Value uniquely identifying the user.
  #     login             String   Login set on GitHub.
  #     name              String   Name set on GitHub.
  #     github_id         Integer  Id set on GitHub.
  #     avatar_url        String   Avatar URL set on GitHub.
  #     education         Boolean  Whether or not the user has an education account.
  #     allow_migration   Unknown  The user's allow_migration.
  #     is_syncing        Boolean  Whether or not the user is currently being synced with GitHub.
  #     synced_at         String   The last time the user was synced with GitHub.
  #
  # **Additional Attributes**
  #
  #     Name          Type          Description
  #     repositories  [Repository]  Repositories belonging to this user.
  #     installation  Installation  Installation belonging to the user.
  #     emails        Unknown       The user's emails.
  #
  # ## Actions
  #
  # **Find**
  #
  # This will return information about an individual user.
  #
  # GET <code>/user/{user.id}</code>
  #
  #     Template Variable  Type     Description
  #     user.id            Integer  Value uniquely identifying the user.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /user/119240
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.user(119_240)
  # ```
  #
  # **Sync**
  #
  # This triggers a sync on a user's account with their GitHub account.
  #
  # POST <code>/user/{user.id}/sync</code>
  #
  #     Template Variable  Type     Description
  #     user.id            Integer  Value uniquely identifying the user.
  #
  #     Example: POST /user/119240/sync
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.user(114_816, :sync)
  # ```
  #
  # **Current**
  #
  # This will return information about the current user.
  #
  # GET <code>/user</code>
  #
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /user
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.user
  # ```
  #
  # @note sync feature may not be permitted
  # @note POST requests require an authorization token set in the headers. See: {authorization=}
  #
  # @param user_id [String, Integer] optional user id
  # @param sync [Boolean] optional argument for syncing your Travis CI account with GitHub
  # @raise [TypeError] if given user id is not a number
  # @return [Success, RequestError]
  def user(user_id = nil, sync = false)
    return get("#{without_repo}/user") if !user_id && !sync

    validate_number user_id

    sync and return post("#{without_repo}/user/#{user_id}/sync")
    get("#{without_repo}/user/#{user_id}")
  end

  # @!endgroup

  private # @private

  def create(url, data = {})
    Trav3::REST.create(self, url, data)
  end

  def cron_keys(hash)
    inject_property_name('cron', hash)
  end

  def delete(url)
    Trav3::REST.delete(self, url)
  end

  def env_var_keys(hash)
    inject_property_name('env_var', hash)
  end

  def get(url, raw_reply = false)
    Trav3::REST.get(self, url, raw_reply)
  end

  def get_path(url)
    get("#{without_repo}#{url}")
  end

  def get_path_with_opts(url, without_limit = true)
    url, opt = url.match(/^(.+)\?(.*)$/)&.captures || url
    opts.immutable do |o|
      o.remove(:limit) if without_limit
      o.send(:update, opt)
      get_path("#{url}#{opts}")
    end
  end

  def initial_defaults
    defaults(limit: 25)
    h('Content-Type': 'application/json')
    h('Accept': 'application/json')
    h('Travis-API-Version': 3)
  end

  def inject_property_name(name, hash)
    raise TypeError, "Hash expected, #{input.class} given" unless hash.is_a? Hash
    return hash.map { |k, v| ["#{name}.#{k}", v] }.to_h unless hash.keys.first.match?(/^#{name}\.\w+$/)

    hash
  end

  def key_pair_keys(hash)
    inject_property_name('key_pair', hash)
  end

  def number?(input)
    /^\d+$/.match? input.to_s
  end

  def opts
    @options
  end

  def patch(url, data)
    Trav3::REST.patch(self, url, data)
  end

  def post(url, body = nil)
    Trav3::REST.post(self, url, body)
  end

  def validate_api_endpoint(input)
    raise InvalidAPIEndpoint unless /^https:\/\/api\.travis-ci\.(?:org|com)$/.match? input
  end

  def validate_number(input)
    raise TypeError, "Integer expected, #{input.class} given" unless number? input
  end

  def validate_repo_format(input)
    raise InvalidRepository unless repo_slug_or_id? input
  end

  def validate_string(input)
    raise TypeError, "String expected, #{input.class} given" unless input.is_a? String
  end

  def repo_slug_or_id?(input)
    Regexp.new(/(^\d+$)|(^[A-Za-z0-9_.-]+(?:\/|%2F){1}[A-Za-z0-9_.-]+$)/i).match? input
  end

  def repository_name
    @repo
  end

  def sanitize_repo_name(repo)
    repo.to_s.gsub(/\//, '%2F')
  end

  def username
    @repo[/.*?(?=(?:\/|%2F)|$)/]
  end

  def with_repo
    "#{api_endpoint}/repo/#{@repo}"
  end

  def without_repo
    api_endpoint
  end

  def without_limit
    limit = opts.remove(:limit)
    result = yield
    opts.build(limit: limit) if limit
    result
  end
end

#headersHeaders (readonly)

Returns Request headers object

Returns:

  • (Headers)

    Request headers object



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
# File 'lib/trav3.rb', line 86

class Travis
  attr_reader :api_endpoint
  attr_reader :options
  attr_reader :headers

  # @param repo [String] github_username/repository_name
  # @raise [InvalidRepository] if given input does not
  #   conform to valid repository identifier format
  # @return [Travis]
  def initialize(repo)
    @api_endpoint = 'https://api.travis-ci.org'

    self.repository = repo

    initial_defaults
  end

  # @!group Request Parameters

  # Set as the API endpoint
  #
  # @param endpoint [String] name for value to set
  # @return [Travis]
  def api_endpoint=(endpoint)
    validate_api_endpoint endpoint
    @api_endpoint = endpoint
  end

  # Set the authorization token in the requests' headers
  #
  # @param token [String] sets authorization token header
  # @return [Travis]
  def authorization=(token)
    validate_string token
    h('Authorization': "token #{token}")
  end

  # Set as many options as you'd like for collections queried via an API request
  #
  # @overload defaults(key: value, ...)
  #   @param key [Symbol] name for value to set
  #   @param value [Symbol, String, Integer] value for key
  # @return [Travis]
  def defaults(**args)
    (@options ||= Options.new).build(args)
    self
  end

  # Set as many headers as you'd like for API requests
  #
  #     h("Authorization": "token xxxxxxxxxxxxxxxxxxxxxx")
  #
  # @overload h(key: value, ...)
  #   @param key [Symbol] name for value to set
  #   @param value [Symbol, String, Integer] value for key
  # @return [Travis]
  def h(**args)
    (@headers ||= Headers.new).build(args)
    self
  end

  # Change the repository this instance of `Trav3::Travis` uses.
  #
  # @param repo_name [String] github_username/repository_name
  # @return [Travis]
  def repository=(repo_name)
    validate_repo_format repo_name
    @repo = sanitize_repo_name repo_name
  end

  # @!endgroup

  # @!group API Endpoints

  # Please Note that the naming of this endpoint may be changed. Our naming convention for this information is in flux. If you have suggestions for how this information should be presented please leave us feedback by commenting in this issue here or emailing support support@travis-ci.com.
  #
  # A list of all the builds in an "active" state, either created or started.
  #
  # ## Attributes
  #
  #     Name    Type    Description
  #     builds  Builds  The active builds.
  #
  # ## Actions
  #
  # **For Owner**
  #
  # Returns a list of "active" builds for the owner.
  #
  # GET <code>/owner/{owner.login}/active</code>
  #
  #     Template Variable  Type    Description
  #     owner.login        String  User or organization login set on GitHub.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /owner/danielpclark/active
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.active
  # # or
  # travis.active('danielpclark')
  # ```
  #
  # GET <code>/owner/{user.login}/active</code>
  #
  #     Template Variable  Type    Description
  #     user.login         String  Login set on GitHub.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /owner/danielpclark/active
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.active
  # # or
  # travis.active('danielpclark')
  # ```
  #
  # GET <code>/owner/{organization.login}/active</code>
  #
  #     Template Variable   Type    Description
  #     organization.login  String  Login set on GitHub.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /owner/travis-ci/active
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.active('travis-ci')
  # ```
  #
  # GET <code>/owner/github_id/{owner.github_id}/active</code>
  #
  #     Template Variable  Type     Description
  #     owner.github_id    Integer  User or organization id set on GitHub.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /owner/github_id/639823/active
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.active(639_823)
  # ```
  #
  # @param owner [String] username, organization name, or github id
  # @return [Success, RequestError]
  def active(owner = username)
    number?(owner) and return get("#{without_repo}/owner/github_id/#{owner}/active")
    get("#{without_repo}/owner/#{owner}/active")
  end

  # A beta feature (a Travis-CI feature currently in beta).
  #
  # ## Attributes
  #
  #     Name          Type     Description
  #     id            Integer  Value uniquely identifying the beta feature.
  #     name          String   The name of the feature.
  #     description   String   Longer description of the feature.
  #     enabled       Boolean  Indicates if the user has this feature turned on.
  #     feedback_url  String   Url for users to leave Travis CI feedback on this feature.
  #
  # ## Actions
  #
  # **Update**
  #
  # This will update a user's beta_feature.
  #
  # Use namespaced params in the request body to pass the `enabled` value (either true or false):
  #
  # ```bash
  # curl -X PATCH \
  #   -H "Content-Type: application/json" \
  #   -H "Travis-API-Version: 3" \
  #   -H "Authorization: token xxxxxxxxxxxx" \
  #   -d '{"beta_feature.enabled":true}' \
  #   https://api.travis-ci.com/user/1234/{beta_feature.id}
  # ```
  #
  # PATCH <code>/user/{user.id}/beta_feature/{beta_feature.id}</code>
  #
  #     Template Variable     Type     Description
  #     user.id               Integer  Value uniquely identifying the user.
  #     beta_feature.id       Integer  Value uniquely identifying the beta feature.
  #     Accepted Parameter    Type     Description
  #     beta_feature.id       Integer  Value uniquely identifying the beta feature.
  #     beta_feature.enabled  Boolean  Indicates if the user has this feature turned on.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.api_endpoint = 'https://api.travis-ci.com'
  # travis.authorization = 'xxxx'
  #
  # # Enable comic-sans for user id 119240
  # travis.beta_feature(:enable, 3, 119_240)
  #
  # # Disable comic-sans for user id 119240
  # travis.beta_feature(:disable, 3, 119_240)
  # ```
  #
  # **Delete**
  #
  # This will delete a user's beta feature.
  #
  # DELETE <code>/user/{user.id}/beta_feature/{beta_feature.id}</code>
  #
  #     Template Variable  Type     Description
  #     user.id            Integer  Value uniquely identifying the user.
  #     beta_feature.id    Integer  Value uniquely identifying the beta feature.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.api_endpoint = 'https://api.travis-ci.com'
  # travis.authorization = 'xxxx'
  #
  # # Disable comic-sans via delete for user id 119240
  # travis.beta_feature(:delete, 3, 119_240)
  # ```
  #
  # @param action [Symbol] either `:enable`, `:disable` or `:delete`
  # @param beta_feature_id [String, Integer] id for the beta feature
  # @param user_id [String] user id
  # @return [Success, RequestError]
  def beta_feature(action, beta_feature_id, user_id)
    validate_number beta_feature_id
    validate_number user_id

    if action != :delete
      params = { 'beta_feature.id' => beta_feature_id, 'beta_feature.enabled' => action == :enable }

      patch("#{without_repo}/user/#{user_id}/beta_feature/#{beta_feature_id}", params)
    else
      delete("#{without_repo}/user/#{user_id}/beta_feature/#{beta_feature_id}")
    end
  end

  # A list of beta features. Beta features are new Travis CI features in beta mode. They can be toggled on or off via the API or on this page on our site: https://travis-ci.com/features
  #
  # ## Attributes
  #
  #     Name           Type            Description
  #     beta_features  [Beta feature]  List of beta_features.
  #
  # ## Actions
  #
  # **Find**
  #
  # This will return a list of beta features available to a user.
  #
  # GET <code>/user/{user.id}/beta_features</code>
  #
  #     Template Variable  Type     Description
  #     user.id            Integer  Value  uniquely identifying the user.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /user/119240/beta_features
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.beta_features(119_240)
  # ```
  #
  # @note requests require an authorization token set in the headers. See: {authorization=}
  #
  # @param user_id [String, Integer] user id
  # @return [Success, RequestError]
  def beta_features(user_id)
    validate_number user_id

    get("#{without_repo}/user/#{user_id}/beta_features")
  end

  # Request migration to beta
  #
  # ## Attributes
  #     Name           Type     Description
  #     id             Unknown  The beta_migration_request's id.
  #     owner_id       Unknown  The beta_migration_request's owner_id.
  #     owner_name     Unknown  The beta_migration_request's owner_name.
  #     owner_type     Unknown  The beta_migration_request's owner_type.
  #     accepted_at    Unknown  The beta_migration_request's accepted_at.
  #     organizations  Unknown  The beta_migration_request's organizations.
  #
  # ## Actions
  #
  # **Create**
  #
  # Submits a request for beta migration
  #
  # POST <code>/user/{user.id}/beta_migration_request</code>
  #
  #     Template Variable  Type     Description
  #     user.id            Integer  Value uniquely identifying the user.
  #     Accepted Parameter                    Type     Description
  #     beta_migration_request.organizations  Unknown  The beta_migration_request's organizations.
  #
  #     Example: POST /user/119240/beta_migration_request
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.beta_migration_request(119_240)
  # ```
  #
  # @note requests require an authorization token set in the headers. See: {authorization=}
  #
  # @param user_id [String, Integer] user id
  # @return [Success, RequestError]
  def beta_migration_request(user_id)
    create("#{without_repo}/user/#{user_id}/beta_migration_request")
  end

  # The branch of a GitHub repository. Useful for obtaining information about the last build on a given branch.
  #
  # **If querying using the repository slug, it must be formatted using {http://www.w3schools.com/tags/ref_urlencode.asp standard URL encoding}, including any special characters.**
  #
  # ## Attributes
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #     Name  Type    Description
  #     name  String  Name of the git branch.
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is {https://developer.travis-ci.com/eager-loading eager loaded}.
  #
  #     Name              Type        Description
  #     name              String      Name of the git branch.
  #     repository        Repository  GitHub user or organization the branch belongs to.
  #     default_branch    Boolean     Whether or not this is the resposiotry's default branch.
  #     exists_on_github  Boolean     Whether or not the branch still exists on GitHub.
  #     last_build        Build       Last build on the branch.
  #
  # **Additional Attributes**
  #
  #     Name           Type     Description
  #     recent_builds  [Build]  Last 10 builds on the branch (when `include=branch.recent_builds` is used).
  #
  # ## Actions
  #
  # **Find**
  #
  # This will return information about an individual branch. The request can include either the repository id or slug.
  #
  # GET <code>/repo/{repository.id}/branch/{branch.name}</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     branch.name        String   Name of the git branch.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /repo/891/branch/master
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.branch('master')
  # ```
  #
  # GET <code>/repo/{repository.slug}/branch/{branch.name}</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     branch.name        String  Name of the git branch.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /repo/rails%2Frails/branch/master
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.branch('master')
  # ```
  #
  # @param name [String] the branch name for the current repository
  # @return [Success, RequestError]
  def branch(name)
    get("#{with_repo}/branch/#{name}")
  end

  # A list of branches.
  #
  # **If querying using the repository slug, it must be formatted using {http://www.w3schools.com/tags/ref_urlencode.asp standard URL encoding}, including any special characters.**
  #
  # ##Attributes
  #
  #     Name      Type      Description
  #     branches  [Branch]  List of branches.
  #
  # **Collection Items**
  #
  # Each entry in the **branches** array has the following attributes:
  #
  #     Name              Type        Description
  #     name              String      Name of the git branch.
  #     repository        Repository  GitHub user or organization the branch belongs to.
  #     default_branch    Boolean     Whether or not this is the resposiotry's default branch.
  #     exists_on_github  Boolean     Whether or not the branch still exists on GitHub.
  #     last_build        Build       Last build on the branch.
  #     recent_builds    [Build]      Last 10 builds on the branch (when `include=branch.recent_builds` is used).
  #
  # ## Actions
  #
  # **Find**
  #
  # This will return a list of branches a repository has on GitHub.
  #
  # GET <code>/repo/{repository.id}/branches</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     Query Parameter          Type       Description
  #     branch.exists_on_github  [Boolean]  Filters branches by whether or not the branch still exists on GitHub.
  #     exists_on_github         [Boolean]  Alias for branch.exists_on_github.
  #     include                  [String]   List of attributes to eager load.
  #     limit                    Integer    How many branches to include in the response. Used for pagination.
  #     offset                   Integer    How many branches to skip before the first entry in the response. Used for pagination.
  #     sort_by                  [String]   Attributes to sort branches by. Used for pagination.
  #
  #     Example: GET /repo/891/branches?limit=5&exists_on_github=true
  #
  # **Sortable by:** <code>name</code>, <code>last_build</code>, <code>exists_on_github</code>, <code>default_branch</code>, append <code>:desc</code> to any attribute to reverse order.
  # The default value is <code>default_branch</code>,<code>exists_on_github</code>,<code>last_build:desc</code>.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.options.build({limit: 5, exists_on_github: true})
  # travis.branches
  # ```
  #
  # GET <code>/repo/{repository.slug}/branches</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     Query Parameter          Type       Description
  #     branch.exists_on_github  [Boolean]  Filters branches by whether or not the branch still exists on GitHub.
  #     exists_on_github         [Boolean]  Alias for branch.exists_on_github.
  #     include                  [String]   List of attributes to eager load.
  #     limit                    Integer    How many branches to include in the response. Used for pagination.
  #     offset                   Integer    How many branches to skip before the first entry in the response. Used for pagination.
  #     sort_by                  [String]   Attributes to sort branches by. Used for pagination.
  #
  #     Example: GET /repo/rails%2Frails/branches?limit=5&exists_on_github=true
  #
  # **Sortable by:** <code>name</code>, <code>last_build</code>, <code>exists_on_github</code>, <code>default_branch</code>, append <code>:desc</code> to any attribute to reverse order.
  # The default value is <code>default_branch</code>,<code>exists_on_github</code>,<code>last_build:desc</code>.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.options.build({limit: 5, exists_on_github: true})
  # travis.branches
  # ```
  #
  # @return [Success, RequestError]
  def branches
    get("#{with_repo}/branches#{opts}")
  end

  # A list of broadcasts for the current user.
  #
  # ## Attributes
  #
  #     Name        Type         Description
  #     broadcasts  [Broadcast]  List of broadcasts.
  #
  # **Collection Items**
  #
  # Each entry in the broadcasts array has the following attributes:
  #
  #     Name        Type     Description
  #     id          Integer  Value uniquely identifying the broadcast.
  #     message     String   Message to display to the user.
  #     created_at  String   When the broadcast was created.
  #     category    String   Broadcast category (used for icon and color).
  #     active      Boolean  Whether or not the brodacast should still be displayed.
  #     recipient   Object   Either a user, organization or repository, or null for global.
  #
  # ## Actions
  #
  # **For Current User**
  #
  # This will return a list of broadcasts for the current user.
  #
  # GET <code>/broadcasts</code>
  #
  #     Query Parameter   Type       Description
  #     active            [Boolean]  Alias for broadcast.active.
  #     broadcast.active  [Boolean]  Filters broadcasts by whether or not the brodacast should still be displayed.
  #     include           [String]   List of attributes to eager load.
  #
  #     Example: GET /broadcasts
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.broadcasts
  # ```
  #
  # @note requests require an authorization token set in the headers. See: {authorization=}
  #
  # @return [Success, RequestError]
  def broadcasts
    get("#{without_repo}/broadcasts")
  end

  # An individual build.
  #
  # ## Attributes
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #     Name                 Type     Description
  #     id                   Integer  Value uniquely identifying the build.
  #     number               String   Incremental number for a repository's builds.
  #     state                String   Current state of the build.
  #     duration             Integer  Wall clock time in seconds.
  #     event_type           String   Event that triggered the build.
  #     previous_state       String   State of the previous build (useful to see if state changed).
  #     pull_request_title   String   Title of the build's pull request.
  #     pull_request_number  Integer  Number of the build's pull request.
  #     started_at           String   When the build started.
  #     finished_at          String   When the build finished.
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is eager loaded.
  #
  #     Name                 Type        Description
  #     id                   Integer     Value uniquely identifying the build.
  #     number               String      Incremental number for a repository's builds.
  #     state                String      Current state of the build.
  #     duration             Integer     Wall clock time in seconds.
  #     event_type           String      Event that triggered the build.
  #     previous_state       String      State of the previous build (useful to see if state changed).
  #     pull_request_title   String      Title of the build's pull request.
  #     pull_request_number  Integer     Number of the build's pull request.
  #     started_at           String      When the build started.
  #     finished_at          String      When the build finished.
  #     repository           Repository  GitHub user or organization the build belongs to.
  #     branch               Branch      The branch the build is associated with.
  #     tag                  Unknown     The build's tag.
  #     commit               Commit      The commit the build is associated with.
  #     jobs                 Jobs        List of jobs that are part of the build's matrix.
  #     stages               [Stage]     The stages of a build.
  #     created_by           Owner       The User or Organization that created the build.
  #     updated_at           Unknown     The build's updated_at.
  #
  # ## Actions
  #
  # **Find**
  #
  # This returns a single build.
  #
  # GET <code>/build/{build.id}</code>
  #
  #     Template Variable  Type     Description
  #     build.id           Integer  Value uniquely identifying the build.
  #
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /build/86601346
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.build(351_778_872)
  # ```
  #
  # **Cancel**
  #
  # This cancels a currently running build. It will set the build and associated jobs to "state": "canceled".
  #
  # POST <code>/build/{build.id}/cancel</code>
  #
  #     Template Variable  Type     Description
  #     build.id           Integer  Value uniquely identifying the build.
  #
  #     Example: POST /build/86601346/cancel
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.build(478_772_528, :cancel)
  # ```
  #
  # **Restart**
  #
  # This restarts a build that has completed or been canceled.
  #
  # POST <code>/build/{build.id}/restart</code>
  #
  #     Template Variable  Type     Description
  #     build.id           Integer  Value uniquely identifying the build.
  #
  #     Example: POST /build/86601346/restart
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.build(478_772_528, :restart)
  # ```
  #
  # @note POST requests require an authorization token set in the headers. See: {authorization=}
  #
  # @param build_id [String, Integer] the build id number
  # @param option [Symbol] options for :cancel or :restart
  # @raise [TypeError] if given build id is not a number
  # @return [Success, RequestError]
  def build(build_id, option = nil)
    validate_number build_id

    case option
    when :cancel
      post("#{without_repo}/build/#{build_id}/cancel")
    when :restart
      post("#{without_repo}/build/#{build_id}/restart")
    else
      get("#{without_repo}/build/#{build_id}")
    end
  end

  # A list of builds.
  #
  # ## Attributes
  #
  #     Name    Type     Description
  #     builds  [Build]  List of builds.
  #
  # **Collection Items**
  #
  # Each entry in the builds array has the following attributes:
  #
  #     Name                 Type        Description
  #     id                   Integer     Value uniquely identifying the build.
  #     number               String      Incremental number for a repository's builds.
  #     state                String      Current state of the build.
  #     duration             Integer     Wall clock time in seconds.
  #     event_type           String      Event that triggered the build.
  #     previous_state       String      State of the previous build (useful to see if state changed).
  #     pull_request_title   String      Title of the build's pull request.
  #     pull_request_number  Integer     Number of the build's pull request.
  #     started_at           String      When the build started.
  #     finished_at          String      When the build finished.
  #     repository           Repository  GitHub user or organization the build belongs to.
  #     branch               Branch      The branch the build is associated with.
  #     tag                  Unknown     The build's tag.
  #     commit               Commit      The commit the build is associated with.
  #     jobs                 Jobs        List of jobs that are part of the build's matrix.
  #     stages               [Stage]     The stages of a build.
  #     created_by           Owner       The User or Organization that created the build.
  #     updated_at           Unknown     The build's updated_at.
  #     request              Unknown     The build's request.
  #
  # ## Actions
  #
  # **For Current User**
  #
  # This returns a list of builds for the current user. The result is paginated.
  #
  # GET <code>/builds</code>
  #
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #     limit            Integer   How many builds to include in the response. Used for pagination.
  #     offset           Integer   How many builds to skip before the first entry in the response. Used for pagination.
  #     sort_by          [String]  Attributes to sort builds by. Used for pagination.
  #
  #     Example: GET /builds?limit=5
  #
  # **Sortable by:** <code>id</code>, <code>started_at</code>, <code>finished_at</code>, append <code>:desc</code> to any attribute to reverse order.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.options.build({limit: 5})
  # travis.builds(false)
  # ```
  #
  # **Find**
  #
  # This returns a list of builds for an individual repository. It is possible to use the repository id or slug in the request. The result is paginated. Each request will return 25 results.
  #
  # GET <code>/repo/{repository.id}/builds</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #
  #     Query Parameter       Type      Description
  #     branch.name           [String]  Filters builds by name of the git branch.
  #     build.created_by      [Owner]   Filters builds by the User or Organization that created the build.
  #     build.event_type      [String]  Filters builds by event that triggered the build.
  #     build.previous_state  [String]  Filters builds by state of the previous build (useful to see if state changed).
  #     build.state           [String]  Filters builds by current state of the build.
  #     created_by            [Owner]   Alias for build.created_by.
  #     event_type            [String]  Alias for build.event_type.
  #     include               [String]  List of attributes to eager load.
  #     limit                 Integer   How many builds to include in the response. Used for pagination.
  #     offset                Integer   How many builds to skip before the first entry in the response. Used for pagination.
  #     previous_state        [String]  Alias for build.previous_state.
  #     sort_by               [String]  Attributes to sort builds by. Used for pagination.
  #     state                 [String]  Alias for build.state.
  #
  #     Example: GET /repo/891/builds?limit=5
  #
  # **Sortable by:** <code>id</code>, <code>started_at</code>, <code>finished_at</code>, append <code>:desc</code> to any attribute to reverse order.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.options.build({limit: 5})
  # travis.builds
  # ```
  #
  # GET <code>/repo/{repository.slug}/builds</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #
  #     Query Parameter       Type      Description
  #     branch.name           [String]  Filters builds by name of the git branch.
  #     build.created_by      [Owner]   Filters builds by the User or Organization that created the build.
  #     build.event_type      [String]  Filters builds by event that triggered the build.
  #     build.previous_state  [String]  Filters builds by state of the previous build (useful to see if state changed).
  #     build.state           [String]  Filters builds by current state of the build.
  #     created_by            [Owner]   Alias for build.created_by.
  #     event_type            [String]  Alias for build.event_type.
  #     include               [String]  List of attributes to eager load.
  #     limit                 Integer   How many builds to include in the response. Used for pagination.
  #     offset                Integer   How many builds to skip before the first entry in the response. Used for pagination.
  #     previous_state        [String]  Alias for build.previous_state.
  #     sort_by               [String]  Attributes to sort builds by. Used for pagination.
  #     state                 [String]  Alias for build.state.
  #
  #     Example: GET /repo/rails%2Frails/builds?limit=5
  #
  # **Sortable by:** <code>id</code>, <code>started_at</code>, <code>finished_at</code>, append <code>:desc</code> to any attribute to reverse order.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.options.build({limit: 5})
  # travis.builds
  # ```
  #
  # @note requests may require an authorization token set in the headers. See: {authorization=}
  #
  # @param repo [Boolean] If true get repo builds, otherwise get user builds
  # @return [Success, RequestError]
  def builds(repo = true)
    repo and return get("#{with_repo}/builds#{opts}")
    get("#{without_repo}/builds#{opts}")
  end

  # A list of jobs.
  #
  # ## Attributes
  #
  #     Name  Type  Description
  #     jobs  [Job]  List of jobs.
  #
  # **Collection Items**
  #
  # Each entry in the jobs array has the following attributes:
  #
  #     Name           Type        Description
  #     id             Integer     Value uniquely identifying the job.
  #     allow_failure  Unknown     The job's allow_failure.
  #     number         String      Incremental number for a repository's builds.
  #     state          String      Current state of the job.
  #     started_at     String      When the job started.
  #     finished_at    String      When the job finished.
  #     build          Build       The build the job is associated with.
  #     queue          String      Worker queue this job is/was scheduled on.
  #     repository     Repository  GitHub user or organization the job belongs to.
  #     commit         Commit      The commit the job is associated with.
  #     owner          Owner       GitHub user or organization the job belongs to.
  #     stage          [Stage]     The stages of a job.
  #     created_at     String      When the job was created.
  #     updated_at     String      When the job was updated.
  #     config         Object      The job's config.
  #
  # ## Actions
  #
  # **Find**
  #
  # This returns a list of jobs belonging to an individual build.
  #
  # GET <code>/build/{build.id}/jobs</code>
  #
  #     Template Variable  Type     Description
  #     build.id           Integer  Value uniquely identifying the build.
  #
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /build/86601346/jobs
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.build_jobs(86_601_346)
  # ```
  #
  # **For Current User**
  #
  # This returns a list of jobs a current user has access to.
  #
  # GET <code>/jobs</code>
  #
  #     Query Parameter  Type      Description
  #     active           Unknown   Alias for job.active.
  #     created_by       Unknown   Alias for job.created_by.
  #     include          [String]  List of attributes to eager load.
  #     job.active       Unknown   Documentation missing.
  #     job.created_by   Unknown   Documentation missing.
  #     job.state        [String]  Filters jobs by current state of the job.
  #     limit            Integer   How many jobs to include in the response. Used for pagination.
  #     offset           Integer   How many jobs to skip before the first entry in the response. Used for pagination.
  #     sort_by          [String]  Attributes to sort jobs by. Used for pagination.
  #     state            [String]  Alias for job.state.
  #
  #     Example: GET /jobs?limit=5
  #
  # **Sortable by:** <code>id</code>, append <code>:desc</code> to any attribute to reverse order.
  # The default value is id:desc.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.options.build({limit: 5})
  # travis.build_jobs(false)
  # ```
  #
  # @note requests may require an authorization token set in the headers. See: {authorization=}
  #
  # @param build_id [String, Integer, Boolean] the build id number.  If falsey then get all jobs for current user
  # @return [Success, RequestError]
  def build_jobs(build_id)
    build_id and return get("#{without_repo}/build/#{build_id}/jobs")
    get("#{without_repo}/jobs#{opts}")
  end

  # A list of caches.
  #
  # If querying using the repository slug, it must be formatted using {http://www.w3schools.com/tags/ref_urlencode.asp standard URL encoding}, including any special characters.
  #
  # ## Attributes
  #
  #     Name    Type    Description
  #     branch  String  The branch the cache belongs to.
  #     match   String  The string to match against the cache name.
  #
  # ## Actions
  #
  # **Find**
  #
  # This returns all the caches for a repository.
  #
  # It's possible to filter by branch or by regexp match of a string to the cache name.
  #
  # ```bash
  # curl \
  #   -H "Content-Type: application/json" \
  #   -H "Travis-API-Version: 3" \
  #   -H "Authorization: token xxxxxxxxxxxx" \
  #   https://api.travis-ci.com/repo/1234/caches?branch=master
  # ```
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.options.build({branch: :master})
  # travis.caches
  # ```
  #
  # ```bash
  # curl \
  #   -H "Content-Type: application/json" \
  #   -H "Travis-API-Version: 3" \
  #   -H "Authorization: token xxxxxxxxxxxx" \
  #   https://api.travis-ci.com/repo/1234/caches?match=linux
  # ```
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.options.build({match: :linux})
  # travis.caches
  # ```
  #
  # GET <code>/repo/{repository.id}/caches</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     Query Parameter  Type      Description
  #     branch           [String]  Alias for caches.branch.
  #     caches.branch    [String]  Filters caches by the branch the cache belongs to.
  #     caches.match     [String]  Filters caches by the string to match against the cache name.
  #     include          [String]  List of attributes to eager load.
  #     match            [String]  Alias for caches.match.
  #
  #     Example: GET /repo/891/caches
  #
  # GET <code>/repo/{repository.slug}/caches</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     Query Parameter  Type      Description
  #     branch           [String]  Alias for caches.branch.
  #     caches.branch    [String]  Filters caches by the branch the cache belongs to.
  #     caches.match     [String]  Filters caches by the string to match against the cache name.
  #     include          [String]  List of attributes to eager load.
  #     match            [String]  Alias for caches.match.
  #
  #     Example: GET /repo/rails%2Frails/caches
  #
  # **Delete**
  #
  # This deletes all caches for a repository.
  #
  # As with `find` it's possible to delete by branch or by regexp match of a string to the cache name.
  #
  # ```bash
  # curl -X DELETE \
  #   -H "Content-Type: application/json" \
  #   -H "Travis-API-Version: 3" \
  #   -H "Authorization: token xxxxxxxxxxxx" \
  #   https://api.travis-ci.com/repo/1234/caches?branch=master
  # ```
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.options.build({branch: :master})
  # travis.caches(:delete)
  # ```
  #
  # DELETE <code>/repo/{repository.id}/caches</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #
  #     Example: DELETE /repo/891/caches
  #
  # DELETE <code>/repo/{repository.slug}/caches</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #
  #     Example: DELETE /repo/rails%2Frails/caches
  #
  # @note DELETE requests require an authorization token set in the headers. See: {authorization=}
  #
  # @param delete [Boolean] option for deleting cache(s)
  # @return [Success, RequestError]
  def caches(delete = false)
    without_limit do
      :delete.==(delete) and return delete("#{with_repo}/caches#{opts}")
      get("#{with_repo}/caches#{opts}")
    end
  end

  # An individual cron. There can be only one cron per branch on a repository.
  #
  # If querying using the repository slug, it must be formatted using {http://www.w3schools.com/tags/ref_urlencode.asp standard URL encoding}, including any special characters.
  #
  # ## Attributes
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #     Name  Type     Description
  #     id    Integer  Value uniquely identifying the cron.
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is {https://developer.travis-ci.com/eager-loading eager loaded}.
  #
  #     Name                             Type        Description
  #     id                               Integer     Value uniquely identifying the cron.
  #     repository                       Repository  Github repository to which this cron belongs.
  #     branch                           Branch      Git branch of repository to which this cron belongs.
  #     interval                         String      Interval at which the cron will run (can be "daily", "weekly" or "monthly").
  #     dont_run_if_recent_build_exists  Boolean     Whether a cron build should run if there has been a build on this branch in the last 24 hours.
  #     last_run                         String      When the cron ran last.
  #     next_run                         String      When the cron is scheduled to run next.
  #     created_at                       String      When the cron was created.
  #     active                           Unknown     The cron's active.
  #
  # ## Actions
  #
  # **Find**
  #
  # This returns a single cron.
  #
  # GET <code>/cron/{cron.id}</code>
  #
  #     Template Variable  Type     Description
  #     cron.id            Integer  Value uniquely identifying the cron.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.cron(id: 78_199)
  # ```
  #
  # **Delete**
  #
  # This deletes a single cron.
  #
  # DELETE <code>/cron/{cron.id}</code>
  #
  #     Template Variable  Type     Description
  #     cron.id            Integer  Value uniquely identifying the cron.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.cron(id: 78_199, delete: true)
  # ```
  #
  # **For Branch**
  #
  # This returns the cron set for the specified branch for the specified repository. It is possible to use the repository id or slug in the request.
  #
  # GET <code>/repo/{repository.id}/branch/{branch.name}/cron</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     branch.name        String   Name of the git branch.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /repo/891/branch/master/cron
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.cron(branch_name: 'master')
  # ```
  #
  # GET <code>/repo/{repository.slug}/branch/{branch.name}/cron</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     branch.name        String  Name of the git branch.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /repo/rails%2Frails/branch/master/cron
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.cron(branch_name: 'master')
  # ```
  #
  # **Create**
  #
  # This creates a cron on the specified branch for the specified repository. It is possible to use the repository id or slug in the request. Content-Type MUST be set in the header and an interval for the cron MUST be specified as a parameter.
  #
  # ```bash
  # curl -X POST \
  #   -H "Content-Type: application/json" \
  #   -H "Travis-API-Version: 3" \
  #   -H "Authorization: token xxxxxxxxxxxx" \
  #   -d '{ "cron.interval": "monthly" }' \
  #   https://api.travis-ci.com/repo/1234/branch/master/cron
  # ```
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.cron(branch_name: 'master', create: { 'interval' => 'monthly' })
  # ```
  #
  # POST <code>/repo/{repository.id}/branch/{branch.name}/cron</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     branch.name        String   Name of the git branch.
  #     Accepted Parameter                    Type     Description
  #     cron.interval                         String   Interval at which the cron will run (can be "daily", "weekly" or "monthly").
  #     cron.dont_run_if_recent_build_exists  Boolean  Whether a cron build should run if there has been a build on this branch in the last 24 hours.
  #
  #     Example: POST /repo/891/branch/master/cron
  #
  # POST <code>/repo/{repository.slug}/branch/{branch.name}/cron</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     branch.name        String  Name of the git branch.
  #     Accepted Parameter                    Type     Description
  #     cron.interval                         String   Interval at which the cron will run (can be "daily", "weekly" or "monthly").
  #     cron.dont_run_if_recent_build_exists  Boolean  Whether a cron build should run if there has been a build on this branch in the last 24 hours.
  #
  #     Example: POST /repo/rails%2Frails/branch/master/cron
  #
  # @param id [String, Integer] cron id to get or delete
  # @param branch_name [String] branch name to get cron or create
  # @param create [Hash] Properties for creating the cron.  `branch_name` keyword argument required and `interval` key/value required.
  # @param delete [Boolean] option for deleting cron.  Cron `id` keyword argument required.
  # @return [Success, RequestError]
  def cron(id: nil, branch_name: nil, create: nil, delete: false)
    if id
      validate_number id

      delete and return delete("#{without_repo}/cron/#{id}")
      return get("#{without_repo}/cron/#{id}")
    end
    raise ArgumentError, 'id or branch_name required' unless branch_name

    create and return create("#{with_repo}/branch/#{branch_name}/cron", cron_keys(create))
    get("#{with_repo}/branch/#{branch_name}/cron")
  end

  # A list of crons.
  #
  # If querying using the repository slug, it must be formatted using {http://www.w3schools.com/tags/ref_urlencode.asp standard URL encoding}, including any special characters.
  #
  # ## Attributes
  #
  #     Name   Type    Description
  #     crons  [Cron]  List of crons.
  #
  # **Collection Items**
  #
  # Each entry in the crons array has the following attributes:
  #
  #     Name                             Type        Description
  #     id                               Integer     Value uniquely identifying the cron.
  #     repository                       Repository  Github repository to which this cron belongs.
  #     branch                           Branch      Git branch of repository to which this cron belongs.
  #     interval                         String      Interval at which the cron will run (can be "daily", "weekly" or "monthly").
  #     dont_run_if_recent_build_exists  Boolean     Whether a cron build should run if there has been a build on this branch in the last 24 hours.
  #     last_run                         String      When the cron ran last.
  #     next_run                         String      When the cron is scheduled to run next.
  #     created_at                       String      When the cron was created.
  #     active                           Unknown     The cron's active.
  #
  # ## Actions
  #
  # **For Repository**
  #
  # This returns a list of crons for an individual repository. It is possible to use the repository id or slug in the request.
  #
  # GET <code>/repo/{repository.id}/crons</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #     limit            Integer   How many crons to include in the response. Used for pagination.
  #     offset           Integer   How many crons to skip before the first entry in the response. Used for pagination.
  #
  #     Example: GET /repo/891/crons?limit=5
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.options.build({limit: 5})
  # travis.crons
  # ```
  #
  # GET <code>/repo/{repository.slug}/crons</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #     limit            Integer   How many crons to include in the response. Used for pagination.
  #     offset           Integer   How many crons to skip before the first entry in the response. Used for pagination.
  #
  #     Example: GET /repo/rails%2Frails/crons?limit=5
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.options.build({limit: 5})
  # travis.crons
  # ```
  #
  # @return [Success, RequestError]
  def crons
    get("#{with_repo}/crons#{opts}")
  end

  # POST <code>/repo/{repository.id}/email_subscription</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #
  #     Example: POST /repo/891/email_subscription
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.email_resubscribe
  # ```
  #
  # POST <code>/repo/{repository.slug}/email_subscription</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #
  #     Example: POST /repo/rails%2Frails/email_subscription
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.email_resubscribe
  # ```
  #
  # @note requests require an authorization token set in the headers. See: {authorization=}
  #
  # @return [Success, RequestError]
  def email_resubscribe
    post("#{with_repo}/email_subscription")
  end

  # DELETE <code>/repo/{repository.id}/email_subscription</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #
  #     Example: DELETE /repo/891/email_subscription
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.email_unsubscribe
  # ```
  #
  # DELETE <code>/repo/{repository.slug}/email_subscription</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #
  #     Example: DELETE /repo/rails%2Frails/email_subscription
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.email_unsubscribe
  # ```
  #
  # @note requests require an authorization token set in the headers. See: {authorization=}
  #
  # @return [Success, RequestError]
  def email_unsubscribe
    delete("#{with_repo}/email_subscription")
  end

  # An individual environment variable.
  #
  # **If querying using the repository slug, it must be formatted using {http://www.w3schools.com/tags/ref_urlencode.asp standard URL encoding}, including any special characters.**
  #
  # ## Attributes
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is {https://developer.travis-ci.com/eager-loading eager loaded}.
  #
  #     Name    Type     Description
  #     id      String   The environment variable id.
  #     name    String   The environment variable name, e.g. FOO.
  #     value   String   The environment variable's value, e.g. bar.
  #     public  Boolean  Whether this environment variable should be publicly visible or not.
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #     Name    Type     Description
  #     id      String   The environment variable id.
  #     name    String   The environment variable name, e.g. FOO.
  #     public  Boolean  Whether this environment variable should be publicly visible or not.
  #
  # ## Actions
  #
  # **Find**
  #
  # This returns a single environment variable. It is possible to use the repository id or slug in the request.
  #
  # GET <code>/repo/{repository.id}/env_var/{env_var.id}</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     env_var.id         String   The environment variable id.
  #     Query Parameter  Type      Description
  #     env_var.id       String    The environment variable id.
  #     id               String    Alias for env_var.id.
  #     include          [String]  List of attributes to eager load.
  #     repository.id    Integer   Value uniquely identifying the repository.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.env_var('76f9d8bd-642d-47ed-9f35-4c25eb030c6c')
  # ```
  #
  # GET <code>/repo/{repository.slug}/env_var/{env_var.id}</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     env_var.id         String  The environment variable id.
  #     Query Parameter  Type      Description
  #     env_var.id       String    The environment variable id.
  #     id               String    Alias for env_var.id.
  #     include          [String]  List of attributes to eager load.
  #     repository.id    Integer   Value uniquely identifying the repository.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.env_var('76f9d8bd-642d-47ed-9f35-4c25eb030c6c')
  # ```
  #
  # **Update**
  #
  # This updates a single environment variable. It is possible to use the repository id or slug in the request.
  #
  # Use namespaced params in the request body to pass the new environment variable:
  #
  # ```bash
  # curl -X PATCH \
  #   -H "Content-Type: application/json" \
  #   -H "Travis-API-Version: 3" \
  #   -H "Authorization: token xxxxxxxxxxxx" \
  #   -d '{ "env_var.value": "bar", "env_var.public": false }' \
  #   https://api.travis-ci.com/repo/1234/{env_var.id}
  # ```
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.env_var('76f9d8bd-642d-47ed-9f35-4c25eb030c6c', update: { value: 'bar', public: false })
  # ```
  #
  # PATCH <code>/repo/{repository.id}/env_var/{env_var.id}</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     env_var.id         String   The environment variable id.
  #     Accepted Parameter  Type     Description
  #     env_var.name        String   The environment variable name, e.g. FOO.
  #     env_var.value       String   The environment variable's value, e.g. bar.
  #     env_var.public      Boolean  Whether this environment variable should be publicly visible or not.
  #
  # PATCH <code>/repo/{repository.slug}/env_var/{env_var.id}</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     env_var.id         String  The environment variable id.
  #     Accepted Parameter  Type     Description
  #     env_var.name        String   The environment variable name, e.g. FOO.
  #     env_var.value       String   The environment variable's value, e.g. bar.
  #     env_var.public      Boolean  Whether this environment variable should be publicly visible or not.
  #
  # **Delete**
  #
  # This deletes a single environment variable. It is possible to use the repository id or slug in the request.
  #
  # DELETE <code>/repo/{repository.id}/env_var/{env_var.id}</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     env_var.id         String   The environment variable id.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.env_var('76f9d8bd-642d-47ed-9f35-4c25eb030c6c', delete: true)
  # ```
  #
  # DELETE <code>/repo/{repository.slug}/env_var/{env_var.id}</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     env_var.id         String  The environment variable id.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.env_var('76f9d8bd-642d-47ed-9f35-4c25eb030c6c', delete: true)
  # ```
  #
  # @overload env_var(env_var_id)
  #   Gets current env var
  #   @param env_var_id [String] environment variable id
  # @overload env_var(env_var_id, action: params)
  #   Performs action per specific key word argument
  #   @param env_var_id [String] environment variable id
  #   @param update [Hash] Optional keyword argument. Update key pair with hash `{ value: "new value" }`
  #   @param delete [Boolean] Optional keyword argument. Use truthy value to delete current key pair
  # @return [Success, RequestError]
  def env_var(env_var_id, update: nil, delete: nil)
    raise 'Too many options specified' unless [update, delete].compact.count < 2

    validate_string env_var_id

    update and return patch("#{with_repo}/env_var/#{env_var_id}", env_var_keys(update))
    delete and return delete("#{with_repo}/env_var/#{env_var_id}")
    get("#{with_repo}/env_var/#{env_var_id}")
  end

  # A list of environment variables.
  #
  # **If querying using the repository slug, it must be formatted using {http://www.w3schools.com/tags/ref_urlencode.asp standard URL encoding}, including any special characters.**
  #
  # ## Attributes
  #
  #     Name      Type       Description
  #     env_vars  [Env var]  List of env_vars.
  #
  # ## Actions
  #
  # **For Repository**
  #
  # This returns a list of environment variables for an individual repository. It is possible to use the repository id or slug in the request.
  #
  # GET <code>/repo/{repository.id}/env_vars</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /repo/891/env_vars
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.env_vars
  # ```
  #
  # GET <code>/repo/{repository.slug}/env_vars</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /repo/rails%2Frails/env_vars
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.env_vars
  # ```
  #
  # **Create**
  #
  # This creates an environment variable for an individual repository. It is possible to use the repository id or slug in the request.
  #
  # Use namespaced params in the request body to pass the new environment variables:
  #
  # ```bash
  # curl -X POST \
  #   -H "Content-Type: application/json" \
  #   -H "Travis-API-Version: 3" \
  #   -H "Authorization: token xxxxxxxxxxxx" \
  #   -d '{ "env_var.name": "FOO", "env_var.value": "bar", "env_var.public": false }' \
  #   https://api.travis-ci.com/repo/1234/env_vars
  # ```
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.env_vars(name: 'FOO', value: 'bar', public: false)
  # ```
  #
  # POST <code>/repo/{repository.id}/env_vars</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     Accepted Parameter  Type     Description
  #     env_var.name        String   The environment variable name, e.g. FOO.
  #     env_var.value       String   The environment variable's value, e.g. bar.
  #     env_var.public      Boolean  Whether this environment variable should be publicly visible or not.
  #
  #     Example: POST /repo/891/env_vars
  #
  # POST <code>/repo/{repository.slug}/env_vars</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     Accepted Parameter  Type     Description
  #     env_var.name        String   The environment variable name, e.g. FOO.
  #     env_var.value       String   The environment variable's value, e.g. bar.
  #     env_var.public      Boolean  Whether this environment variable should be publicly visible or not.
  #
  #     Example: POST /repo/rails%2Frails/env_vars
  #
  # @note requests require an authorization token set in the headers. See: {authorization=}
  #
  # @param create [Hash] Optional argument.  A hash of the `name`, `value`, and `public` visibleness for a env var to create
  # @return [Success, RequestError]
  def env_vars(create = nil)
    create and return create("#{with_repo}/env_vars", env_var_keys(create))
    get("#{with_repo}/env_vars")
  end

  # A GitHub App installation.
  #
  # ## Attributes
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #     Name       Type     Description
  #     id         Integer  The installation id.
  #     github_id  Integer  The installation's id on GitHub.
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is {https://developer.travis-ci.com/eager-loading eager loaded}.
  #
  #     Name       Type     Description
  #     id         Integer  The installation id.
  #     github_id  Integer  The installation's id on GitHub.
  #     owner      Owner    GitHub user or organization the installation belongs to.
  #
  # ## Actions
  #
  # **Find**
  #
  # This returns a single installation.
  #
  # GET <code>/installation/{installation.github_id}</code>
  #
  #     Template Variable       Type     Description
  #     installation.github_id  Integer  The installation's id on GitHub.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.api_endpoint = 'https://api.travis-ci.com'
  # travis.authorization = 'xxxx'
  # travis.installation(617_754)
  # ```
  #
  # @param installation_id [String, Integer] GitHub App installation id
  # @return [Success, RequestError]
  def installation(installation_id)
    validate_number installation_id

    get("#{without_repo}/installation/#{installation_id}")
  end

  # An individual job.
  #
  # ## Attributes
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #     Name  Type     Description
  #     id    Integer  Value uniquely identifying the job.
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is eager loaded.
  #
  #     Name           Type        Description
  #     id             Integer     Value uniquely identifying the job.
  #     allow_failure  Unknown     The job's allow_failure.
  #     number         String      Incremental number for a repository's builds.
  #     state          String      Current state of the job.
  #     started_at     String      When the job started.
  #     finished_at    String      When the job finished.
  #     build          Build       The build the job is associated with.
  #     queue          String      Worker queue this job is/was scheduled on.
  #     repository     Repository  GitHub user or organization the job belongs to.
  #     commit         Commit      The commit the job is associated with.
  #     owner          Owner       GitHub user or organization the job belongs to.
  #     stage          [Stage]     The stages of a job.
  #     created_at     String      When the job was created.
  #     updated_at     String      When the job was updated.
  #
  # ## Actions
  #
  # **Find**
  #
  # This returns a single job.
  #
  # GET <code>/job/{job.id}</code>
  #
  #     Template Variable  Type     Description
  #     job.id             Integer  Value uniquely identifying the job.
  #
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /job/86601347
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.job(351_778_875)
  # ```
  #
  # **Cancel**
  #
  # This cancels a currently running job.
  #
  # POST <code>/job/{job.id}/cancel</code>
  #
  #     Template Variable  Type     Description
  #     job.id             Integer  Value uniquely identifying the job.
  #
  #     Example: POST /job/86601347/cancel
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.job(351_778_875, :cancel)
  # ```
  #
  # **Restart**
  #
  # This restarts a job that has completed or been canceled.
  #
  # POST <code>/job/{job.id}/restart</code>
  #
  #     Template Variable  Type     Description
  #     job.id             Integer  Value uniquely identifying the job.
  #
  #     Example: POST /job/86601347/restart
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.job(351_778_875, :restart)
  # ```
  #
  # **Debug**
  #
  # This restarts a job in debug mode, enabling the logged-in user to ssh into the build VM. Please note this feature is only available on the travis-ci.com domain, and those repositories on the travis-ci.org domain for which the debug feature is enabled. See this document for more details.
  #
  # POST <code>/job/{job.id}/debug</code>
  #
  #     Template Variable  Type     Description
  #     job.id             Integer  Value uniquely identifying the job.
  #
  #     Example: POST /job/86601347/debug
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.api_endpoint = 'https://api.travis-ci.com'
  # travis.authorization = 'xxxx'
  # travis.job(351_778_875, :debug)
  # ```
  #
  # @note POST requests require an authorization token set in the headers. See: {authorization=}
  # @note **Debug** is only available on the travis-ci.com domain, and those repositories on the travis-ci.org domain for which the debug feature is enabled.
  #
  # @param job_id [String, Integer] the job id number
  # @param option [Symbol] options for :cancel, :restart, or :debug
  # @return [Success, RequestError]
  def job(job_id, option = nil)
    case option
    when :cancel
      post("#{without_repo}/job/#{job_id}/cancel")
    when :restart
      post("#{without_repo}/job/#{job_id}/restart")
    when :debug
      post("#{without_repo}/job/#{job_id}/debug")
    else
      get("#{without_repo}/job/#{job_id}")
    end
  end

  # Users may add a public/private RSA key pair to a repository.
  # This can be used within builds, for example to access third-party services or deploy code to production.
  # Please note this feature is only available on the travis-ci.com domain.
  #
  # ## Attributes
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is {https://developer.travis-ci.com/eager-loading eager loaded}.
  #
  #     Name         Type    Description
  #     description  String  A text description.
  #     public_key   String  The public key.
  #     fingerprint  String  The fingerprint.
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #     Name         Type    Description
  #     description  String  A text description.
  #     public_key   String  The public key.
  #     fingerprint  String  The fingerprint.
  #
  # ## Actions
  #
  # **Find**
  #
  # Return the current key pair, if it exists.
  #
  # GET <code>/repo/{repository.id}/key_pair</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /repo/891/key_pair
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.api_endpoint = 'https://api.travis-ci.com'
  # travis.authorization = 'xxxx'
  # travis.key_pair
  # ```
  #
  # GET <code>/repo/{repository.slug}/key_pair</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /repo/rails%2Frails/key_pair
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.api_endpoint = 'https://api.travis-ci.com'
  # travis.authorization = 'xxxx'
  # travis.key_pair
  # ```
  #
  # **Create**
  #
  # Creates a new key pair.
  #
  # ```bash
  # curl -X POST \
  #   -H "Content-Type: application/json" \
  #   -H "Travis-API-Version: 3" \
  #   -H "Authorization: token xxxxxxxxxxxx" \
  #   -d '{ "key_pair.description": "FooBar", "key_pair.value": "xxxxx"}' \
  #   https://api.travis-ci.com/repo/1234/key_pair
  # ```
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.api_endpoint = 'https://api.travis-ci.com'
  # travis.authorization = 'xxxx'
  # travis.key_pair(create: { description: 'FooBar', value: OpenSSL::PKey::RSA.generate(2048).to_s })
  # ```
  #
  # POST <code>/repo/{repository.id}/key_pair</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     Accepted Parameter    Type    Description
  #     key_pair.description  String  A text description.
  #     key_pair.value        String  The private key.
  #
  #     Example: POST /repo/891/key_pair
  #
  # POST <code>/repo/{repository.slug}/key_pair</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     Accepted Parameter    Type    Description
  #     key_pair.description  String  A text description.
  #     key_pair.value        String  The private key.
  #
  #     Example: POST /repo/rails%2Frails/key_pair
  #
  # **Update**
  #
  # Update the key pair.
  #
  # ```bash
  # curl -X PATCH \
  #   -H "Content-Type: application/json" \
  #   -H "Travis-API-Version: 3" \
  #   -H "Authorization: token xxxxxxxxxxxx" \
  #   -d '{ "key_pair.description": "FooBarBaz" }' \
  #   https://api.travis-ci.com/repo/1234/key_pair
  # ```
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.api_endpoint = 'https://api.travis-ci.com'
  # travis.authorization = 'xxxx'
  # travis.key_pair(update: { description: 'FooBarBaz' })
  # ```
  #
  # PATCH <code>/repo/{repository.id}/key_pair</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     Accepted Parameter    Type    Description
  #     key_pair.description  String  A text description.
  #     key_pair.value        String  The private key.
  #
  #     Example: PATCH /repo/891/key_pair
  #
  # PATCH <code>/repo/{repository.slug}/key_pair</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     Accepted Parameter    Type    Description
  #     key_pair.description  String  A text description.
  #     key_pair.value        String  The private key.
  #
  #     Example: PATCH /repo/rails%2Frails/key_pair
  #
  # **Delete**
  #
  # Delete the key pair.
  #
  # DELETE <code>/repo/{repository.id}/key_pair</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #
  #     Example: DELETE /repo/891/key_pair
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.api_endpoint = 'https://api.travis-ci.com'
  # travis.authorization = 'xxxx'
  # travis.key_pair(delete: true)
  # ```
  #
  # DELETE <code>/repo/{repository.slug}/key_pair</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #
  #     Example: DELETE /repo/rails%2Frails/key_pair
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.api_endpoint = 'https://api.travis-ci.com'
  # travis.authorization = 'xxxx'
  # travis.key_pair(delete: true)
  # ```
  #
  # @note requests require an authorization token set in the headers. See: {authorization=}
  # @note API enpoint needs to be set to `https://api.travis-ci.com` See: {api_endpoint=}
  #
  # @overload key_pair()
  #   Gets current key_pair if any
  # @overload key_pair(action: params)
  #   Performs action per specific key word argument
  #   @param create [Hash] Optional keyword argument.  Create a new key pair from provided private key `{ description: "name", value: "private key" }`
  #   @param update [Hash] Optional keyword argument.  Update key pair with hash `{ description: "new name" }`
  #   @param delete [Boolean] Optional keyword argument.  Use truthy value to delete current key pair
  # @return [Success, RequestError]
  def key_pair(create: nil, update: nil, delete: nil)
    raise 'Too many options specified' unless [create, update, delete].compact.count < 2

    create and return create("#{with_repo}/key_pair", key_pair_keys(create))
    update and return patch("#{with_repo}/key_pair", key_pair_keys(update))
    delete and return delete("#{with_repo}/key_pair")
    get("#{with_repo}/key_pair")
  end

  # Every repository has an auto-generated RSA key pair. This is used when cloning the repository from GitHub and when encrypting/decrypting secure data for use in builds, e.g. via the Travis CI command line client.
  #
  # Users may read the public key and fingerprint via GET request, or generate a new key pair via POST, but otherwise this key pair cannot be edited or removed.
  #
  # ## Attributes
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is {https://developer.travis-ci.com/eager-loading eager loaded}.
  #
  #     Name         Type    Description
  #     description  String  A text description.
  #     public_key   String  The public key.
  #     fingerprint  String  The fingerprint.
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #     Name         Type    Description
  #     description  String  A text description.
  #     public_key   String  The public key.
  #     fingerprint  String  The fingerprint.
  #
  # ## Actions
  #
  # **Find**
  #
  # Return the current key pair.
  #
  # GET <code>/repo/{repository.id}/key_pair/generated</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /repo/891/key_pair/generated
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.api_endpoint = 'https://api.travis-ci.com'
  # travis.authorization = 'xxxx'
  # travis.key_pair_generated
  # ```
  #
  # GET <code>/repo/{repository.slug}/key_pair/generated</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /repo/rails%2Frails/key_pair/generated
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.api_endpoint = 'https://api.travis-ci.com'
  # travis.authorization = 'xxxx'
  # travis.key_pair_generated
  # ```
  #
  # **Create**
  #
  # Generate a new key pair, replacing the previous one.
  #
  # POST <code>/repo/{repository.id}/key_pair/generated</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #
  #     Example: POST /repo/891/key_pair/generated
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.api_endpoint = 'https://api.travis-ci.com'
  # travis.authorization = 'xxxx'
  # travis.key_pair_generated(:create)
  # ```
  #
  # POST <code>/repo/{repository.slug}/key_pair/generated</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #
  #     Example: POST /repo/rails%2Frails/key_pair/generated
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.api_endpoint = 'https://api.travis-ci.com'
  # travis.authorization = 'xxxx'
  # travis.key_pair_generated(:create)
  # ```
  #
  # @note requests require an authorization token set in the headers. See: {authorization=}
  #
  # @param action [String, Symbol] defaults to getting current key pair, use `:create` if you would like to generate a new key pair
  # @return [Success, RequestError]
  def key_pair_generated(action = :get)
    return post("#{with_repo}/key_pair/generated") if action.match?(/create/i)

    get("#{with_repo}/key_pair/generated")
  end

  # This validates the `.travis.yml` file and returns any warnings.
  #
  # The request body can contain the content of the .travis.yml file directly as a string, eg "foo: bar".
  #
  # ## Attributes
  #
  #     Name      Type   Description
  #     warnings  Array  An array of hashes with keys and warnings.
  #
  # ## Actions
  #
  # **Lint**
  #
  # POST <code>/lint</code>
  #
  #     Example: POST /lint
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.lint(File.read('.travis.yml'))
  # ```
  #
  # @param yaml_content [String] the contents for the file `.travis.yml`
  # @return [Success, RequestError]
  def lint(yaml_content)
    validate_string yaml_content

    ct = headers.remove(:'Content-Type')
    result = post("#{without_repo}/lint", yaml_content)
    h('Content-Type': ct) if ct
    result
  end

  # An individual log.
  #
  # ## Attributes
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #     Name  Type     Description
  #     id    Unknown  The log's id.
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is eager loaded.
  #
  #     Name       Type     Description
  #     id         Unknown  The log's id.
  #     content    Unknown  The log's content.
  #     log_parts  Unknown  The log's log_parts.
  #
  # ## Actions
  #
  # **Find**
  #
  # This returns a single log.
  #
  # It's possible to specify the accept format of the request as text/plain if required. This will return the content of the log as a single blob of text.
  #
  #     curl -H "Travis-API-Version: 3" \
  #       -H "Accept: text/plain" \
  #       -H "Authorization: token xxxxxxxxxxxx" \
  #       https://api.travis-ci.org/job/{job.id}/log
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.log(351_778_875)
  # # or
  # travis.log(351_778_875, :text)
  # ```
  #
  # The default response type is application/json, and will include additional meta data such as @type, @representation etc. (see [https://developer.travis-ci.org/format](https://developer.travis-ci.org/format)).
  #
  # GET <code>/job/{job.id}/log</code>
  #
  #     Template Variable  Type     Description
  #     job.id             Integer  Value uniquely identifying the job.
  #
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #     log.token        Unknown   Documentation missing.
  #
  #     Example: GET /job/86601347/log
  #
  # GET <code>/job/{job.id}/log.txt</code>
  #
  #     Template Variable  Type     Description
  #     job.id             Integer  Value uniquely identifying the job.
  #
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #     log.token        Unknown   Documentation missing.
  #
  #     Example: GET /job/86601347/log.txt
  #
  # **Delete**
  #
  # This removes the contents of a log. It gets replace with the message: Log removed by XXX at 2017-02-13 16:00:00 UTC.
  #
  #     curl -X DELETE \
  #       -H "Travis-API-Version: 3" \
  #       -H "Authorization: token xxxxxxxxxxxx" \
  #       https://api.travis-ci.org/job/{job.id}/log
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.log(478_772_530, :delete)
  # ```
  #
  # DELETE <code>/job/{job.id}/log</code>
  #
  #     Template Variable  Type     Description
  #     job.id             Integer  Value uniquely identifying the job.
  #
  #     Example: DELETE /job/86601347/log
  #
  # @param job_id [String, Integer] the job id number
  # @param option [Symbol] options for :text or :delete
  # @return [Success, String, RequestError]
  def log(job_id, option = nil)
    case option
    when :text
      get("#{without_repo}/job/#{job_id}/log.txt", true)
    when :delete
      delete("#{without_repo}/job/#{job_id}/log")
    else
      get("#{without_repo}/job/#{job_id}/log")
    end
  end

  # A list of messages. Messages belong to resource types.
  #
  # ## Attributes
  #
  #     Name      Type       Description
  #     messages  [Message]  List of messages.
  #
  # **Collection Items**
  #
  # Each entry in the messages array has the following attributes:
  #
  #     Name   Type     Description
  #     id     Integer  The message's id.
  #     level  String   The message's level.
  #     key    String   The message's key.
  #     code   String   The message's code.
  #     args   Json     The message's args.
  #
  # ## Actions
  #
  # **For Request**
  #
  # This will return a list of messages created by `travis-yml` for a request, if any exist.
  #
  # GET <code>/repo/{repository.id}/request/{request.id}/messages</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     request.id         Integer  Value uniquely identifying the request.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #     limit            Integer   How many messages to include in the response. Used for pagination.
  #     offset           Integer   How many messages to skip before the first entry in the response. Used for pagination.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.messages(147_731_561)
  # ```
  #
  # GET <code>/repo/{repository.slug}/request/{request.id}/messages</code>
  #
  #     Template Variable  Type     Description
  #     repository.slug    String   Same as {repository.owner.name}/{repository.name}.
  #     request.id         Integer  Value uniquely identifying the request.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #     limit            Integer   How many messages to include in the response. Used for pagination.
  #     offset           Integer   How many messages to skip before the first entry in the response. Used for pagination.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.messages(147_731_561)
  # ```
  #
  # @param request_id [String, Integer] the request id
  # @return [Success, RequestError]
  def messages(request_id)
    validate_number request_id

    get("#{with_repo}/request/#{request_id}/messages")
  end

  # An individual organization.
  #
  # ## Attributes
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #     Name   Type     Description
  #     id     Integer  Value uniquely identifying the organization.
  #     login  String   Login set on GitHub.
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is {https://developer.travis-ci.com/eager-loading eager loaded}.
  #
  #     Name             Type     Description
  #     id               Integer  Value uniquely identifying the organization.
  #     login            String   Login set on GitHub.
  #     name             String   Name set on GitHub.
  #     github_id        Integer  Id set on GitHub.
  #     avatar_url       String   Avatar_url set on GitHub.
  #     education        Boolean  Whether or not the organization has an education account.
  #     allow_migration  Unknown  The organization's allow_migration.
  #
  # **Additional Attributes**
  #
  #     Name          Type          Description
  #     repositories  [Repository]  Repositories belonging to this organization.
  #     installation  Installation  Installation belonging to the organization.
  #
  # ## Actions
  #
  # **Find**
  #
  # This returns an individual organization.
  #
  # GET <code>/org/{organization.id}</code>
  #
  #     Template Variable  Type      Description
  #     organization.id    Integer   Value uniquely identifying the organization.
  #     Query Parameter    Type      Description
  #     include            [String]  List of attributes to eager load.
  #
  #     Example: GET /org/87
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.organization(87)
  # ```
  #
  # @param org_id [String, Integer] the organization id
  # @raise [TypeError] if given organization id is not a number
  # @return [Success, RequestError]
  def organization(org_id)
    validate_number org_id

    get("#{without_repo}/org/#{org_id}")
  end

  # A list of organizations for the current user.
  #
  # ## Attributes
  #
  #     Name           Type            Description
  #     organizations  [Organization]  List of organizations.
  #
  # **Collection Items**
  #
  # Each entry in the **organizations** array has the following attributes:
  #
  #     Name             Type          Description
  #     id               Integer       Value uniquely identifying the organization.
  #     login            String        Login set on GitHub.
  #     name             String        Name set on GitHub.
  #     github_id        Integer       Id set on GitHub.
  #     avatar_url       String        Avatar_url set on GitHub.
  #     education        Boolean       Whether or not the organization has an education account.
  #     allow_migration  Unknown       The organization's allow_migration.
  #     repositories     [Repository]  Repositories belonging to this organization.
  #     installation     Installation  Installation belonging to the organization.
  #
  # ## Actions
  #
  # **For Current User**
  #
  # This returns a list of organizations the current user is a member of.
  #
  # GET <code>/orgs</code>
  #
  #     Query Parameter    Type      Description
  #     include            [String]  List of attributes to eager load.
  #     limit              Integer   How many organizations to include in the response. Used for pagination.
  #     offset             Integer   How many organizations to skip before the first entry in the response. Used for pagination.
  #     organization.role  Unknown   Documentation missing.
  #     role               Unknown   Alias for organization.role.
  #     sort_by            [String]  Attributes to sort organizations by. Used for pagination.
  #
  #     Example: GET /orgs?limit=5
  #
  # **Sortable by:** <code>id</code>, <code>login</code>, <code>name</code>, <code>github_id</code>, append <code>:desc</code> to any attribute to reverse order.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.options.build({limit: 5})
  # travis.organizations
  # ```
  #
  # @return [Success, RequestError]
  def organizations
    get("#{without_repo}/orgs#{opts}")
  end

  # This will be either a {https://developer.travis-ci.com/resource/user user} or {https://developer.travis-ci.com/resource/organization organization}.
  #
  # ## Attributes
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #     Name    Type     Description
  #     id      Integer  Value uniquely identifying the owner.
  #     login   String   User or organization login set on GitHub.
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is {https://developer.travis-ci.com/eager-loading eager loaded}.
  #
  #     Name        Type     Description
  #     id          Integer  Value uniquely identifying the owner.
  #     login       String   User or organization login set on GitHub.
  #     name        String   User or organization name set on GitHub.
  #     github_id   Integer  User or organization id set on GitHub.
  #     avatar_url  String   Link to user or organization avatar (image) set on GitHub.
  #
  # **Additional Attributes**
  #
  #     Name           Type           Description
  #     repositories   [Repository]   Repositories belonging to this account.
  #
  # ## Actions
  #
  # **Find**
  #
  # This returns an individual owner. It is possible to use the GitHub login or github_id in the request.
  #
  # GET <code>/owner/{owner.login}</code>
  #
  #     Template Variable  Type      Description
  #     owner.login        String    User or organization login set on GitHub.
  #
  #     Query Parameter    Type      Description
  #     include            [String]  List of attributes to eager load.
  #
  #     Example: GET /owner/danielpclark
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.owner
  # # or
  # travis.owner('danielpclark')
  # ```
  #
  # GET <code>/owner/{user.login}</code>
  #
  #     Template Variable  Type      Description
  #     user.login         String    Login set on GitHub.
  #
  #     Query Parameter    Type      Description
  #     include            [String]  List of attributes to eager load.
  #
  #     Example: GET /owner/danielpclark
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.owner
  # # or
  # travis.owner('danielpclark')
  # ```
  #
  # GET <code>/owner/{organization.login}</code>
  #
  #     Template Variable   Type      Description
  #     organization.login  String    Login set on GitHub.
  #
  #     Query Parameter     Type      Description
  #     include             [String]  List of attributes to eager load.
  #
  #     Example: GET /owner/travis-ci
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.owner('travis-ci')
  # ```
  #
  # GET <code>/owner/github_id/{owner.github_id}</code>
  #
  #     Template Variable   Type      Description
  #     owner.github_id     Integer   User or organization id set on GitHub.
  #
  #     Query Parameter     Type      Description
  #     include             [String]  List of attributes to eager load.
  #
  #     Example: GET /owner/github_id/639823
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.owner(639_823)
  # ```
  #
  # @param owner [String] username or github id
  # @return [Success, RequestError]
  def owner(owner = username)
    number?(owner) and return get("#{without_repo}/owner/github_id/#{owner}")
    get("#{without_repo}/owner/#{owner}")
  end

  # Individual preferences for current user or organization.
  #
  # ## Attributes
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is {https://developer.travis-ci.com/eager-loading eager loaded}.
  #
  #     Name   Type     Description
  #     name   Unknown  The preference's name.
  #     value  Unknown  The preference's value.
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #     Name   Type     Description
  #     name   Unknown  The preference's name.
  #     value  Unknown  The preference's value.
  #
  # ## Actions
  #
  # **For Organization**
  #
  # Get preference for organization.
  #
  # GET <code>/org/{organization.id}/preference/{preference.name}</code>
  #
  #     Template Variable  Type     Description
  #     organization.id    Integer  Value uniquely identifying the organization.
  #     preference.name    Unknown  The preference's name.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.preference('private_insights_visibility', org_id: 107_660)
  # ```
  #
  # **Update**
  #
  # Set preference for organization.
  #
  # PATCH <code>/org/{organization.id}/preference/{preference.name}</code>
  #
  #     Template Variable  Type     Description
  #     organization.id    Integer  Value uniquely identifying the organization.
  #     preference.name    Unknown  The preference's name.
  #     Accepted Parameter  Type     Description
  #     preference.value    Unknown  The preference's value.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.preference('private_insights_visibility', 'admins', org_id: 107_660)
  # ```
  #
  # Set preference for current user.
  #
  # PATCH <code>/preference/{preference.name}</code>
  #
  #     Template Variable  Type     Description
  #     preference.name    Unknown  The preference's name.
  #     Accepted Parameter  Type     Description
  #     preference.value    Unknown  The preference's value.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.preference('build_emails', true)
  # ```
  #
  # **Find**
  #
  # Get preference for current user.
  #
  # GET <code>/preference/{preference.name}</code>
  #
  #     Template Variable  Type     Description
  #     preference.name    Unknown  The preference's name.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.preference('build_emails')
  # ```
  #
  # @note requests require an authorization token set in the headers. See: {authorization=}
  #
  # @param key [String] preference name to get or set
  # @param value [String] optional value to set preference
  # @param org_id [String, Integer] optional keyword argument for an organization id
  # @return [Success, RequestError]
  def preference(key, value = nil, org_id: nil)
    if org_id
      validate_number org_id
      org_id = "/org/#{org_id}"
    end

    value and return patch("#{without_repo}#{org_id}/preference/#{key}", 'preference.value' => value)
    get("#{without_repo}#{org_id}/preference/#{key}")
  end

  # Preferences for current user or organization.
  #
  # ## Attributes
  #
  #     Name         Type         Description
  #     preferences  [Preferenc]  List of preferences.
  #
  # ## Actions
  #
  # **For Organization**
  #
  # Gets preferences for organization.
  #
  # GET <code>/org/{organization.id}/preferences</code>
  #
  #     Template Variable  Type     Description
  #     organization.id    Integer  Value uniquely identifying the organization.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /org/87/preferences
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.preferences(107_660)
  # ```
  #
  # **For User**
  #
  # Gets preferences for current user.
  #
  # GET <code>/preferences</code>
  #
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /preferences
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.preferences
  # ```
  #
  # @note requests require an authorization token set in the headers. See: {authorization=}
  #
  # @param org_id [String, Integer] optional organization id
  # @return [Success, RequestError]
  def preferences(org_id = nil)
    if org_id
      validate_number org_id
      org_id = "/org/#{org_id}"
    end

    get("#{without_repo}#{org_id}/preferences")
  end

  # A list of repositories for the current user.
  #
  # ## Attributes
  #
  #     Name           Type           Description
  #     repositories   [Repository]   List of repositories.
  #
  # **Collection Items**
  #
  # Each entry in the repositories array has the following attributes:
  #
  #     Name                Type     Description
  #     id                  Integer  Value uniquely identifying the repository.
  #     name                String   The repository's name on GitHub.
  #     slug                String   Same as {repository.owner.name}/{repository.name}.
  #     description         String   The repository's description from GitHub.
  #     github_language     String   The main programming language used according to GitHub.
  #     active              Boolean  Whether or not this repository is currently enabled on Travis CI.
  #     private             Boolean  Whether or not this repository is private.
  #     owner               Owner    GitHub user or organization the repository belongs to.
  #     default_branch      Branch   The default branch on GitHub.
  #     starred             Boolean  Whether or not this repository is starred.
  #     current_build       Build    The most recently started build (this excludes builds that have been created but have not yet started).
  #     last_started_build  Build    Alias for current_build.
  #
  # ## Actions
  #
  # **For Owner**
  #
  # This returns a list of repositories an owner has access to.
  #
  # GET <code>/owner/{owner.login}/repos</code>
  #
  #     Template Variable  Type    Description
  #     owner.login        String  User or organization login set on GitHub.
  #
  #     Query Parameter     Type       Description
  #     active              [Boolean]  Alias for repository.active.
  #     include             [String]   List of attributes to eager load.
  #     limit               Integer    How many repositories to include in the response. Used for pagination.
  #     offset              Integer    How many repositories to skip before the first entry in the response. Used for pagination.
  #     private             [Boolean]  Alias for repository.private.
  #     repository.active   [Boolean]  Filters repositories by whether or not this repository is currently enabled on Travis CI.
  #     repository.private  [Boolean]  Filters repositories by whether or not this repository is private.
  #     repository.starred  [Boolean]  Filters repositories by whether or not this repository is starred.
  #     sort_by             [String]   Attributes to sort repositories by. Used for pagination.
  #     starred             [Boolean]  Alias for repository.starred.
  #
  #     Example: GET /owner/danielpclark/repos?limit=5&sort_by=active,name
  #
  # **Sortable by:** <code>id</code>, <code>github_id</code>, <code>owner_name</code>, <code>name</code>, <code>active</code>, <code>default_branch.last_build</code>, append <code>:desc</code> to any attribute to reverse order.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.options.build({limit: 5, sort_by: 'active,name'})
  # travis.repositories
  # # or
  # travis.repositories('danielpclark')
  # ```
  #
  # GET <code>/owner/{user.login}/repos</code>
  #
  #     Template Variable  Type    Description
  #     user.login         String  Login set on GitHub.
  #
  #     Query Parameter     Type       Description
  #     active              [Boolean]  Alias for repository.active.
  #     include             [String]   List of attributes to eager load.
  #     limit               Integer    How many repositories to include in the response. Used for pagination.
  #     offset              Integer    How many repositories to skip before the first entry in the response. Used for pagination.
  #     private             [Boolean]  Alias for repository.private.
  #     repository.active   [Boolean]  Filters repositories by whether or not this repository is currently enabled on Travis CI.
  #     repository.private  [Boolean]  Filters repositories by whether or not this repository is private.
  #     repository.starred  [Boolean]  Filters repositories by whether or not this repository is starred.
  #     sort_by             [String]   Attributes to sort repositories by. Used for pagination.
  #     starred             [Boolean]  Alias for repository.starred.
  #
  #     Example: GET /owner/danielpclark/repos?limit=5&sort_by=active,name
  #
  # **Sortable by:** <code>id</code>, <code>github_id</code>, <code>owner_name</code>, <code>name</code>, <code>active</code>, <code>default_branch.last_build</code>, append <code>:desc</code> to any attribute to reverse order.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.options.build({limit: 5, sort_by: 'active,name'})
  # travis.repositories
  # # or
  # travis.repositories('danielpclark')
  # ```
  #
  # GET <code>/owner/{organization.login}/repos</code>
  #
  #     Template Variable   Type    Description
  #     organization.login  String  Login set on GitHub.
  #
  #     Query Parameter     Type       Description
  #     active              [Boolean]  Alias for repository.active.
  #     include             [String]   List of attributes to eager load.
  #     limit               Integer    How many repositories to include in the response. Used for pagination.
  #     offset              Integer    How many repositories to skip before the first entry in the response. Used for pagination.
  #     private             [Boolean]  Alias for repository.private.
  #     repository.active   [Boolean]  Filters repositories by whether or not this repository is currently enabled on Travis CI.
  #     repository.private  [Boolean]  Filters repositories by whether or not this repository is private.
  #     repository.starred  [Boolean]  Filters repositories by whether or not this repository is starred.
  #     sort_by             [String]   Attributes to sort repositories by. Used for pagination.
  #     starred             [Boolean]  Alias for repository.starred.
  #
  #     Example: GET /owner/travis-ci/repos?limit=5&sort_by=active,name
  #
  # **Sortable by:** <code>id</code>, <code>github_id</code>, <code>owner_name</code>, <code>name</code>, <code>active</code>, <code>default_branch.last_build</code>, append <code>:desc</code> to any attribute to reverse order.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.options.build({limit: 5, sort_by: 'active,name'})
  # travis.repositories('travis-ci')
  # ```
  #
  # GET <code>/owner/github_id/{owner.github_id}/repos</code>
  #
  #     Template Variable  Type     Description
  #     owner.github_id    Integer  User or organization id set on GitHub.
  #
  #     Query Parameter     Type       Description
  #     active              [Boolean]  Alias for repository.active.
  #     include             [String]   List of attributes to eager load.
  #     limit               Integer    How many repositories to include in the response. Used for pagination.
  #     offset              Integer    How many repositories to skip before the first entry in the response. Used for pagination.
  #     private             [Boolean]  Alias for repository.private.
  #     repository.active   [Boolean]  Filters repositories by whether or not this repository is currently enabled on Travis CI.
  #     repository.private  [Boolean]  Filters repositories by whether or not this repository is private.
  #     repository.starred  [Boolean]  Filters repositories by whether or not this repository is starred.
  #     sort_by             [String]   Attributes to sort repositories by. Used for pagination.
  #     starred             [Boolean]  Alias for repository.starred.
  #
  #     Example: GET /owner/github_id/639823/repos?limit=5&sort_by=active,name
  #
  # **Sortable by:** <code>id</code>, <code>github_id</code>, <code>owner_name</code>, <code>name</code>, <code>active</code>, <code>default_branch.last_build</code>, append <code>:desc</code> to any attribute to reverse order.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.options.build({limit: 5, sort_by: 'active,name'})
  # travis.repositories(639_823)
  # ```
  #
  # **For Current User**
  #
  # This returns a list of repositories the current user has access to.
  #
  # GET <code>/repos</code>
  #
  #     Query Parameter     Type       Description
  #     active              [Boolean]  Alias for repository.active.
  #     include             [String]   List of attributes to eager load.
  #     limit               Integer    How many repositories to include in the response. Used for pagination.
  #     offset              Integer    How many repositories to skip before the first entry in the response. Used for pagination.
  #     private             [Boolean]  Alias for repository.private.
  #     repository.active   [Boolean]  Filters repositories by whether or not this repository is currently enabled on Travis CI.
  #     repository.private  [Boolean]  Filters repositories by whether or not this repository is private.
  #     repository.starred  [Boolean]  Filters repositories by whether or not this repository is starred.
  #     sort_by             [String]   Attributes to sort repositories by. Used for pagination.
  #     starred             [Boolean]  Alias for repository.starred.
  #
  #     Example: GET /repos?limit=5&sort_by=active,name
  #
  # **Sortable by:** <code>id</code>, <code>github_id</code>, <code>owner_name</code>, <code>name</code>, <code>active</code>, <code>default_branch.last_build</code>, append <code>:desc</code> to any attribute to reverse order.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.options.build({limit: 5, sort_by: 'active,name'})
  # travis.repositories(:self)
  # ```
  #
  # @param owner [String, Integer, Symbol] username, github id, or `:self`
  # @return [Success, RequestError]
  def repositories(owner = username)
    owner.equal?(:self) and return get("#{without_repo}/repos#{opts}")
    number?(owner) and return get("#{without_repo}/owner/github_id/#{owner}/repos#{opts}")
    get("#{without_repo}/owner/#{owner}/repos#{opts}")
  end

  # An individual repository.
  #
  # ## Attributes
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #     Name   Type     Description
  #     id     Integer  Value uniquely identifying the repository.
  #     name   String   The repository's name on GitHub.
  #     slug   String   Same as {repository.owner.name}/{repository.name}.
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is eager loaded.
  #
  #     Name             Type     Description
  #     id               Integer  Value uniquely identifying the repository.
  #     name             String   The repository's name on GitHub.
  #     slug             String   Same as {repository.owner.name}/{repository.name}.
  #     description      String   The repository's description from GitHub.
  #     github_language  String   The main programming language used according to GitHub.
  #     active           Boolean  Whether or not this repository is currently enabled on Travis CI.
  #     private          Boolean  Whether or not this repository is private.
  #     owner            Owner    GitHub user or organization the repository belongs to.
  #     default_branch   Branch   The default branch on GitHub.
  #     starred          Boolean  Whether or not this repository is starred.
  #
  # ## Actions
  #
  # **Find**
  #
  # This returns an individual repository.
  #
  # GET <code>/repo/{repository.id}</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /repo/891
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.repository('danielpclark/trav3')
  # ```
  #
  # GET <code>/repo/{repository.slug}</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /repo/rails%2Frails
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.repository('danielpclark/trav3')
  # ```
  #
  # **Activate**
  #
  # This will activate a repository, allowing its tests to be run on Travis CI.
  #
  # POST <code>/repo/{repository.id}/activate</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #
  #     Example: POST /repo/891/activate
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.repository('danielpclark/trav3', :activate)
  # ```
  #
  # POST <code>/repo/{repository.slug}/activate</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #
  #     Example: POST /repo/rails%2Frails/activate
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.repository('danielpclark/trav3', :activate)
  # ```
  #
  # **Deactivate**
  #
  # This will deactivate a repository, preventing any tests from running on Travis CI.
  #
  # POST <code>/repo/{repository.id}/deactivate</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #
  #     Example: POST /repo/891/deactivate
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.repository('danielpclark/trav3', :deactivate)
  # ```
  #
  # POST <code>/repo/{repository.slug}/deactivate</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #
  #     Example: POST /repo/rails%2Frails/deactivate
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.repository('danielpclark/trav3', :deactivate)
  # ```
  #
  # **Star**
  #
  # This will star a repository based on the currently logged in user.
  #
  # POST <code>/repo/{repository.id}/star</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #
  #     Example: POST /repo/891/star
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.repository('danielpclark/trav3', :star)
  # ```
  #
  # POST <code>/repo/{repository.slug}/star</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #
  #     Example: POST /repo/rails%2Frails/star
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.repository('danielpclark/trav3', :star)
  # ```
  #
  # **Unstar**
  #
  # This will unstar a repository based on the currently logged in user.
  #
  # POST <code>/repo/{repository.id}/unstar</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #
  #     Example: POST /repo/891/unstar
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.repository('danielpclark/trav3', :unstar)
  # ```
  #
  # POST <code>/repo/{repository.slug}/unstar</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #
  #     Example: POST /repo/rails%2Frails/unstar
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.repository('danielpclark/trav3', :unstar)
  # ```
  #
  # @note POST requests require an authorization token set in the headers. See: {authorization=}
  #
  # @param repo [String] github_username/repository_name
  # @param action [String, Symbol] Optional argument for star/unstar/activate/deactivate
  # @raise [InvalidRepository] if given input does not
  #   conform to valid repository identifier format
  # @return [Success, RequestError]
  def repository(repo = repository_name, action = nil)
    validate_repo_format repo

    repo = sanitize_repo_name repo

    action and return post("#{without_repo}/repo/#{repo}/#{action}")
    get("#{without_repo}/repo/#{repo}")
  end

  # An individual request
  #
  # ## Attributes
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #     Name     Type     Description
  #     id       Integer  Value uniquely identifying the request.
  #     state    String   The state of a request (eg. whether it has been processed or not).
  #     result   String   The result of the request (eg. rejected or approved).
  #     message  String   Travis-ci status message attached to the request.
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is {https://developer.travis-ci.com/eager-loading eager loaded}.
  #
  #     Name         Type        Description
  #     id           Integer     Value uniquely identifying the request.
  #     state        String      The state of a request (eg. whether it has been processed or not).
  #     result       String      The result of the request (eg. rejected or approved).
  #     message      String      Travis-ci status message attached to the request.
  #     repository   Repository  GitHub user or organization the request belongs to.
  #     branch_name  String      Name of the branch requested to be built.
  #     commit       Commit      The commit the request is associated with.
  #     builds       [Build]     The request's builds.
  #     owner        Owner       GitHub user or organization the request belongs to.
  #     created_at   String      When Travis CI created the request.
  #     event_type   String      Origin of request (push, pull request, api).
  #     base_commit  String      The base commit the request is associated with.
  #     head_commit  String      The head commit the request is associated with.
  #
  # ## Actions
  #
  # **Find**
  #
  # Get the request by id for the current repository
  #
  # GET <code>/repo/{repository.id}/request/{request.id}</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     request.id         Integer  Value uniquely identifying the request.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.request(147_776_757)
  # ```
  #
  # GET <code>/repo/{repository.slug}/request/{request.id}</code>
  #
  #     Template Variable  Type     Description
  #     repository.slug    String   Same as {repository.owner.name}/{repository.name}.
  #     request.id         Integer  Value uniquely identifying the request.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.request(147_776_757)
  # ```
  #
  # @param request_id [String, Integer] request id
  # @return [Success, RequestError]
  def request(request_id)
    validate_number request_id

    get("#{with_repo}/request/#{request_id}")
  end

  # A list of requests.
  #
  # If querying using the repository slug, it must be formatted using {http://www.w3schools.com/tags/ref_urlencode.asp standard URL encoding}, including any special characters.
  #
  # ## Attributes
  #
  #     Name      Type       Description
  #     requests  [Request]  List of requests.
  #
  # **Collection Items**
  #
  # Each entry in the **requests** array has the following attributes:
  #
  #     Name         Type        Description
  #     id           Integer     Value uniquely identifying the request.
  #     state        String      The state of a request (eg. whether it has been processed or not).
  #     result       String      The result of the request (eg. rejected or approved).
  #     message      String      Travis-ci status message attached to the request.
  #     repository   Repository  GitHub user or organization the request belongs to.
  #     branch_name  String      Name of the branch requested to be built.
  #     commit       Commit      The commit the request is associated with.
  #     builds       [Build]     The request's builds.
  #     owner        Owner       GitHub user or organization the request belongs to.
  #     created_at   String      When Travis CI created the request.
  #     event_type   String      Origin of request (push, pull request, api).
  #     base_commit  String      The base commit the request is associated with.
  #     head_commit  String      The head commit the request is associated with.
  #     yaml_config  Unknown     The request's yaml_config.
  #
  # ## Actions
  #
  # **Find**
  #
  # This will return a list of requests belonging to a repository.
  #
  # GET <code>/repo/{repository.id}/requests</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #     limit            Integer   How many requests to include in the response. Used for pagination.
  #     offset           Integer   How many requests to skip before the first entry in the response. Used for pagination.
  #
  #     Example: GET /repo/891/requests?limit=5
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.options.build({limit: 5})
  # travis.requests
  # ```
  #
  # GET <code>/repo/{repository.slug}/requests</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #     limit            Integer   How many requests to include in the response. Used for pagination.
  #     offset           Integer   How many requests to skip before the first entry in the response. Used for pagination.
  #
  #     Example: GET /repo/rails%2Frails/requests?limit=5
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.options.build({limit: 5})
  # travis.requests
  # ```
  #
  # **Create**
  #
  # This will create a request for an individual repository, triggering a build to run on Travis CI.
  #
  # Use namespaced params in JSON format in the request body to pass any accepted parameters. Any keys in the request's config will override keys existing in the `.travis.yml`.
  #
  # ```bash
  # curl -X POST \
  #   -H "Content-Type: application/json" \
  #   -H "Travis-API-Version: 3" \
  #   -H "Authorization: token xxxxxxxxxxxx" \
  #   -d '{ "request": {
  #         "message": "Override the commit message: this is an api request", "branch": "master" }}'\
  #   https://api.travis-ci.com/repo/1/requests
  # ```
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.requests(
  #   message: 'Override the commit message: this is an api request',
  #   branch: 'master'
  # )
  # ```
  #
  # The response includes the following body:
  #
  # ```json
  # {
  #   "@type":              "pending",
  #   "remaining_requests": 1,
  #   "repository":         {
  #     "@type":            "repository",
  #     "@href":            "/repo/1",
  #     "@representation":  "minimal",
  #     "id":               1,
  #     "name":             "test",
  #     "slug":             "owner/repo"
  #   },
  #   "request":            {
  #     "repository":       {
  #       "id":             1,
  #       "owner_name":     "owner",
  #       "name":           "repo"
  #     },
  #     "user":             {
  #       "id":             1
  #     },
  #     "id":               1,
  #     "message":          "Override the commit message: this is an api request",
  #     "branch":           "master",
  #     "config":           { }
  #   },
  #   "resource_type":      "request"
  # }
  # ```
  #
  # POST <code>/repo/{repository.id}/requests</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     Accepted Parameter  Type    Description
  #     request.config      String  Build configuration (as parsed from .travis.yml).
  #     request.message     String  Travis-ci status message attached to the request.
  #     request.branch      String  Branch requested to be built.
  #     request.token       Object  Travis token associated with webhook on GitHub (DEPRECATED).
  #
  #     Example: POST /repo/891/requests
  #
  # POST <code>/repo/{repository.slug}/requests</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     Accepted Parameter  Type    Description
  #     request.config      String  Build configuration (as parsed from .travis.yml).
  #     request.message     String  Travis-ci status message attached to the request.
  #     request.branch      String  Branch requested to be built.
  #     request.token       Object  Travis token associated with webhook on GitHub (DEPRECATED).
  #
  #     Example: POST /repo/rails%2Frails/requests
  #
  # @param attributes [Hash] request attributes
  # @return [Success, RequestError]
  def requests(**attributes)
    return get("#{with_repo}/requests") if attributes.empty?

    create("#{with_repo}/requests", 'request': attributes)
  end

  # A list of stages.
  #
  # Currently this is nested within a build.
  #
  # ## Attributes
  #
  #     Name    Type     Description
  #     stages  [Stage]  List of stages.
  #
  # **Collection Items**
  #
  # Each entry in the stages array has the following attributes:
  #
  #     Name         Type     Description
  #     id           Integer  Value uniquely identifying the stage.
  #     number       Integer  Incremental number for a stage.
  #     name         String   The name of the stage.
  #     state        String   Current state of the stage.
  #     started_at   String   When the stage started.
  #     finished_at  String   When the stage finished.
  #     jobs         [Job]    The jobs of a stage.
  #
  # ## Actions
  #
  # **Find**
  #
  # This returns a list of stages belonging to an individual build.
  #
  # GET <code>/build/{build.id}/stages</code>
  #
  #     Template Variable  Type     Description
  #     build.id           Integer  Value uniquely identifying the build.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /build/86601346/stages
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.stages(479_113_572)
  # ```
  #
  # @param build_id [String, Integer] build id
  # @raise [TypeError] if given build id is not a number
  # @return [Success, RequestError]
  def stages(build_id)
    validate_number build_id

    get("#{without_repo}/build/#{build_id}/stages")
  end

  # An individual repository setting. These are settings on a repository that can be adjusted by the user. There are currently five different kinds of settings a user can modify:
  #
  # * `builds_only_with_travis_yml` (boolean)
  # * `build_pushes` (boolean)
  # * `build_pull_requests` (boolean)
  # * `maximum_number_of_builds` (integer)
  # * `auto_cancel_pushes` (boolean)
  # * `auto_cancel_pull_requests` (boolean)
  #
  # If querying using the repository slug, it must be formatted using {http://www.w3schools.com/tags/ref_urlencode.asp standard URL encoding}, including any special characters.
  #
  # ## Attributes
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is {https://developer.travis-ci.com/eager-loading eager loaded}.
  #
  #     Name   Type                Description
  #     name   String              The setting's name.
  #     value  Boolean or integer  The setting's value.
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #   Name   Type                Description
  #   name   String              The setting's name.
  #   value  Boolean or integer  The setting's value.
  #
  # ## Actions
  #
  # **Find**
  #
  # This returns a single setting. It is possible to use the repository id or slug in the request.
  #
  # GET <code>/repo/{repository.id}/setting/{setting.name}</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     setting.name       String   The setting's name.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.setting('auto_cancel_pull_requests')
  # ```
  #
  # GET <code>/repo/{repository.slug}/setting/{setting.name}</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     setting.name       String  The setting's name.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.setting('auto_cancel_pull_requests')
  # ```
  #
  # **Update**
  #
  # This updates a single setting. It is possible to use the repository id or slug in the request.
  #
  # Use namespaced params in the request body to pass the new setting:
  #
  # ```bash
  # curl -X PATCH \
  #   -H "Content-Type: application/json" \
  #   -H "Travis-API-Version: 3" \
  #   -H "Authorization: token xxxxxxxxxxxx" \
  #   -d '{ "setting.value": true }' \
  #   https://api.travis-ci.com/repo/1234/setting/{setting.name}
  # ```
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.setting('auto_cancel_pull_requests', false)
  # ```
  #
  # PATCH <code>/repo/{repository.id}/setting/{setting.name}</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     setting.name       String   The setting's name.
  #     Accepted Parameter  Type                Description
  #     setting.value       Boolean or integer  The setting's value.
  #
  # PATCH <code>/repo/{repository.slug}/setting/{setting.name}</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     setting.name       String  The setting's name.
  #     Accepted Parameter  Type                Description
  #     setting.value       Boolean or integer  The setting's value.
  #
  # @param name [String] the setting name for the current repository
  # @param value [String] optional argument for setting a value for the setting name
  # @return [Success, RequestError]
  def setting(name, value = nil)
    return get("#{with_repo}/setting/#{name}") if value.nil?

    patch("#{with_repo}/setting/#{name}", 'setting.value' => value)
  end

  # A list of user settings. These are settings on a repository that can be adjusted by the user. There are currently six different kinds of user settings:
  #
  # * `builds_only_with_travis_yml` (boolean)
  # * `build_pushes` (boolean)
  # * `build_pull_requests` (boolean)
  # * `maximum_number_of_builds` (integer)
  # * `auto_cancel_pushes` (boolean)
  # * `auto_cancel_pull_requests` (boolean)
  #
  # If querying using the repository slug, it must be formatted using {http://www.w3schools.com/tags/ref_urlencode.asp standard URL encoding}, including any special characters.
  #
  # ## Attributes
  #
  #     Name      Type       Description
  #     settings  [Setting]  List of settings.
  #
  # **Collection Items**
  #
  # Each entry in the settings array has the following attributes:
  #
  #     Name   Type                Description
  #     name   String              The setting's name.
  #     value  Boolean or integer  The setting's value.
  #
  # ## Actions
  #
  # **For Repository**
  #
  # This returns a list of the settings for that repository. It is possible to use the repository id or slug in the request.
  #
  # GET <code>/repo/{repository.id}/settings</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /repo/891/settings
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.settings
  # ```
  #
  # GET <code>/repo/{repository.slug}/settings</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /repo/rails%2Frails/settings
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.settings
  # ```
  #
  # @return [Success, RequestError]
  def settings
    get("#{with_repo}/settings")
  end

  # An individual user.
  #
  # ## Attributes
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #     Name  Type     Description
  #     id    Integer  Value uniquely identifying the user.
  #     login String   Login set on GitHub.
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is {https://developer.travis-ci.com/eager-loading eager loaded}.
  #
  #     Name              Type     Description
  #     id                Integer  Value uniquely identifying the user.
  #     login             String   Login set on GitHub.
  #     name              String   Name set on GitHub.
  #     github_id         Integer  Id set on GitHub.
  #     avatar_url        String   Avatar URL set on GitHub.
  #     education         Boolean  Whether or not the user has an education account.
  #     allow_migration   Unknown  The user's allow_migration.
  #     is_syncing        Boolean  Whether or not the user is currently being synced with GitHub.
  #     synced_at         String   The last time the user was synced with GitHub.
  #
  # **Additional Attributes**
  #
  #     Name          Type          Description
  #     repositories  [Repository]  Repositories belonging to this user.
  #     installation  Installation  Installation belonging to the user.
  #     emails        Unknown       The user's emails.
  #
  # ## Actions
  #
  # **Find**
  #
  # This will return information about an individual user.
  #
  # GET <code>/user/{user.id}</code>
  #
  #     Template Variable  Type     Description
  #     user.id            Integer  Value uniquely identifying the user.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /user/119240
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.user(119_240)
  # ```
  #
  # **Sync**
  #
  # This triggers a sync on a user's account with their GitHub account.
  #
  # POST <code>/user/{user.id}/sync</code>
  #
  #     Template Variable  Type     Description
  #     user.id            Integer  Value uniquely identifying the user.
  #
  #     Example: POST /user/119240/sync
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.user(114_816, :sync)
  # ```
  #
  # **Current**
  #
  # This will return information about the current user.
  #
  # GET <code>/user</code>
  #
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /user
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.user
  # ```
  #
  # @note sync feature may not be permitted
  # @note POST requests require an authorization token set in the headers. See: {authorization=}
  #
  # @param user_id [String, Integer] optional user id
  # @param sync [Boolean] optional argument for syncing your Travis CI account with GitHub
  # @raise [TypeError] if given user id is not a number
  # @return [Success, RequestError]
  def user(user_id = nil, sync = false)
    return get("#{without_repo}/user") if !user_id && !sync

    validate_number user_id

    sync and return post("#{without_repo}/user/#{user_id}/sync")
    get("#{without_repo}/user/#{user_id}")
  end

  # @!endgroup

  private # @private

  def create(url, data = {})
    Trav3::REST.create(self, url, data)
  end

  def cron_keys(hash)
    inject_property_name('cron', hash)
  end

  def delete(url)
    Trav3::REST.delete(self, url)
  end

  def env_var_keys(hash)
    inject_property_name('env_var', hash)
  end

  def get(url, raw_reply = false)
    Trav3::REST.get(self, url, raw_reply)
  end

  def get_path(url)
    get("#{without_repo}#{url}")
  end

  def get_path_with_opts(url, without_limit = true)
    url, opt = url.match(/^(.+)\?(.*)$/)&.captures || url
    opts.immutable do |o|
      o.remove(:limit) if without_limit
      o.send(:update, opt)
      get_path("#{url}#{opts}")
    end
  end

  def initial_defaults
    defaults(limit: 25)
    h('Content-Type': 'application/json')
    h('Accept': 'application/json')
    h('Travis-API-Version': 3)
  end

  def inject_property_name(name, hash)
    raise TypeError, "Hash expected, #{input.class} given" unless hash.is_a? Hash
    return hash.map { |k, v| ["#{name}.#{k}", v] }.to_h unless hash.keys.first.match?(/^#{name}\.\w+$/)

    hash
  end

  def key_pair_keys(hash)
    inject_property_name('key_pair', hash)
  end

  def number?(input)
    /^\d+$/.match? input.to_s
  end

  def opts
    @options
  end

  def patch(url, data)
    Trav3::REST.patch(self, url, data)
  end

  def post(url, body = nil)
    Trav3::REST.post(self, url, body)
  end

  def validate_api_endpoint(input)
    raise InvalidAPIEndpoint unless /^https:\/\/api\.travis-ci\.(?:org|com)$/.match? input
  end

  def validate_number(input)
    raise TypeError, "Integer expected, #{input.class} given" unless number? input
  end

  def validate_repo_format(input)
    raise InvalidRepository unless repo_slug_or_id? input
  end

  def validate_string(input)
    raise TypeError, "String expected, #{input.class} given" unless input.is_a? String
  end

  def repo_slug_or_id?(input)
    Regexp.new(/(^\d+$)|(^[A-Za-z0-9_.-]+(?:\/|%2F){1}[A-Za-z0-9_.-]+$)/i).match? input
  end

  def repository_name
    @repo
  end

  def sanitize_repo_name(repo)
    repo.to_s.gsub(/\//, '%2F')
  end

  def username
    @repo[/.*?(?=(?:\/|%2F)|$)/]
  end

  def with_repo
    "#{api_endpoint}/repo/#{@repo}"
  end

  def without_repo
    api_endpoint
  end

  def without_limit
    limit = opts.remove(:limit)
    result = yield
    opts.build(limit: limit) if limit
    result
  end
end

#optionsOptions (readonly)

Returns Request options object

Returns:

  • (Options)

    Request options object



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
# File 'lib/trav3.rb', line 86

class Travis
  attr_reader :api_endpoint
  attr_reader :options
  attr_reader :headers

  # @param repo [String] github_username/repository_name
  # @raise [InvalidRepository] if given input does not
  #   conform to valid repository identifier format
  # @return [Travis]
  def initialize(repo)
    @api_endpoint = 'https://api.travis-ci.org'

    self.repository = repo

    initial_defaults
  end

  # @!group Request Parameters

  # Set as the API endpoint
  #
  # @param endpoint [String] name for value to set
  # @return [Travis]
  def api_endpoint=(endpoint)
    validate_api_endpoint endpoint
    @api_endpoint = endpoint
  end

  # Set the authorization token in the requests' headers
  #
  # @param token [String] sets authorization token header
  # @return [Travis]
  def authorization=(token)
    validate_string token
    h('Authorization': "token #{token}")
  end

  # Set as many options as you'd like for collections queried via an API request
  #
  # @overload defaults(key: value, ...)
  #   @param key [Symbol] name for value to set
  #   @param value [Symbol, String, Integer] value for key
  # @return [Travis]
  def defaults(**args)
    (@options ||= Options.new).build(args)
    self
  end

  # Set as many headers as you'd like for API requests
  #
  #     h("Authorization": "token xxxxxxxxxxxxxxxxxxxxxx")
  #
  # @overload h(key: value, ...)
  #   @param key [Symbol] name for value to set
  #   @param value [Symbol, String, Integer] value for key
  # @return [Travis]
  def h(**args)
    (@headers ||= Headers.new).build(args)
    self
  end

  # Change the repository this instance of `Trav3::Travis` uses.
  #
  # @param repo_name [String] github_username/repository_name
  # @return [Travis]
  def repository=(repo_name)
    validate_repo_format repo_name
    @repo = sanitize_repo_name repo_name
  end

  # @!endgroup

  # @!group API Endpoints

  # Please Note that the naming of this endpoint may be changed. Our naming convention for this information is in flux. If you have suggestions for how this information should be presented please leave us feedback by commenting in this issue here or emailing support support@travis-ci.com.
  #
  # A list of all the builds in an "active" state, either created or started.
  #
  # ## Attributes
  #
  #     Name    Type    Description
  #     builds  Builds  The active builds.
  #
  # ## Actions
  #
  # **For Owner**
  #
  # Returns a list of "active" builds for the owner.
  #
  # GET <code>/owner/{owner.login}/active</code>
  #
  #     Template Variable  Type    Description
  #     owner.login        String  User or organization login set on GitHub.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /owner/danielpclark/active
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.active
  # # or
  # travis.active('danielpclark')
  # ```
  #
  # GET <code>/owner/{user.login}/active</code>
  #
  #     Template Variable  Type    Description
  #     user.login         String  Login set on GitHub.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /owner/danielpclark/active
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.active
  # # or
  # travis.active('danielpclark')
  # ```
  #
  # GET <code>/owner/{organization.login}/active</code>
  #
  #     Template Variable   Type    Description
  #     organization.login  String  Login set on GitHub.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /owner/travis-ci/active
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.active('travis-ci')
  # ```
  #
  # GET <code>/owner/github_id/{owner.github_id}/active</code>
  #
  #     Template Variable  Type     Description
  #     owner.github_id    Integer  User or organization id set on GitHub.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /owner/github_id/639823/active
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.active(639_823)
  # ```
  #
  # @param owner [String] username, organization name, or github id
  # @return [Success, RequestError]
  def active(owner = username)
    number?(owner) and return get("#{without_repo}/owner/github_id/#{owner}/active")
    get("#{without_repo}/owner/#{owner}/active")
  end

  # A beta feature (a Travis-CI feature currently in beta).
  #
  # ## Attributes
  #
  #     Name          Type     Description
  #     id            Integer  Value uniquely identifying the beta feature.
  #     name          String   The name of the feature.
  #     description   String   Longer description of the feature.
  #     enabled       Boolean  Indicates if the user has this feature turned on.
  #     feedback_url  String   Url for users to leave Travis CI feedback on this feature.
  #
  # ## Actions
  #
  # **Update**
  #
  # This will update a user's beta_feature.
  #
  # Use namespaced params in the request body to pass the `enabled` value (either true or false):
  #
  # ```bash
  # curl -X PATCH \
  #   -H "Content-Type: application/json" \
  #   -H "Travis-API-Version: 3" \
  #   -H "Authorization: token xxxxxxxxxxxx" \
  #   -d '{"beta_feature.enabled":true}' \
  #   https://api.travis-ci.com/user/1234/{beta_feature.id}
  # ```
  #
  # PATCH <code>/user/{user.id}/beta_feature/{beta_feature.id}</code>
  #
  #     Template Variable     Type     Description
  #     user.id               Integer  Value uniquely identifying the user.
  #     beta_feature.id       Integer  Value uniquely identifying the beta feature.
  #     Accepted Parameter    Type     Description
  #     beta_feature.id       Integer  Value uniquely identifying the beta feature.
  #     beta_feature.enabled  Boolean  Indicates if the user has this feature turned on.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.api_endpoint = 'https://api.travis-ci.com'
  # travis.authorization = 'xxxx'
  #
  # # Enable comic-sans for user id 119240
  # travis.beta_feature(:enable, 3, 119_240)
  #
  # # Disable comic-sans for user id 119240
  # travis.beta_feature(:disable, 3, 119_240)
  # ```
  #
  # **Delete**
  #
  # This will delete a user's beta feature.
  #
  # DELETE <code>/user/{user.id}/beta_feature/{beta_feature.id}</code>
  #
  #     Template Variable  Type     Description
  #     user.id            Integer  Value uniquely identifying the user.
  #     beta_feature.id    Integer  Value uniquely identifying the beta feature.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.api_endpoint = 'https://api.travis-ci.com'
  # travis.authorization = 'xxxx'
  #
  # # Disable comic-sans via delete for user id 119240
  # travis.beta_feature(:delete, 3, 119_240)
  # ```
  #
  # @param action [Symbol] either `:enable`, `:disable` or `:delete`
  # @param beta_feature_id [String, Integer] id for the beta feature
  # @param user_id [String] user id
  # @return [Success, RequestError]
  def beta_feature(action, beta_feature_id, user_id)
    validate_number beta_feature_id
    validate_number user_id

    if action != :delete
      params = { 'beta_feature.id' => beta_feature_id, 'beta_feature.enabled' => action == :enable }

      patch("#{without_repo}/user/#{user_id}/beta_feature/#{beta_feature_id}", params)
    else
      delete("#{without_repo}/user/#{user_id}/beta_feature/#{beta_feature_id}")
    end
  end

  # A list of beta features. Beta features are new Travis CI features in beta mode. They can be toggled on or off via the API or on this page on our site: https://travis-ci.com/features
  #
  # ## Attributes
  #
  #     Name           Type            Description
  #     beta_features  [Beta feature]  List of beta_features.
  #
  # ## Actions
  #
  # **Find**
  #
  # This will return a list of beta features available to a user.
  #
  # GET <code>/user/{user.id}/beta_features</code>
  #
  #     Template Variable  Type     Description
  #     user.id            Integer  Value  uniquely identifying the user.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /user/119240/beta_features
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.beta_features(119_240)
  # ```
  #
  # @note requests require an authorization token set in the headers. See: {authorization=}
  #
  # @param user_id [String, Integer] user id
  # @return [Success, RequestError]
  def beta_features(user_id)
    validate_number user_id

    get("#{without_repo}/user/#{user_id}/beta_features")
  end

  # Request migration to beta
  #
  # ## Attributes
  #     Name           Type     Description
  #     id             Unknown  The beta_migration_request's id.
  #     owner_id       Unknown  The beta_migration_request's owner_id.
  #     owner_name     Unknown  The beta_migration_request's owner_name.
  #     owner_type     Unknown  The beta_migration_request's owner_type.
  #     accepted_at    Unknown  The beta_migration_request's accepted_at.
  #     organizations  Unknown  The beta_migration_request's organizations.
  #
  # ## Actions
  #
  # **Create**
  #
  # Submits a request for beta migration
  #
  # POST <code>/user/{user.id}/beta_migration_request</code>
  #
  #     Template Variable  Type     Description
  #     user.id            Integer  Value uniquely identifying the user.
  #     Accepted Parameter                    Type     Description
  #     beta_migration_request.organizations  Unknown  The beta_migration_request's organizations.
  #
  #     Example: POST /user/119240/beta_migration_request
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.beta_migration_request(119_240)
  # ```
  #
  # @note requests require an authorization token set in the headers. See: {authorization=}
  #
  # @param user_id [String, Integer] user id
  # @return [Success, RequestError]
  def beta_migration_request(user_id)
    create("#{without_repo}/user/#{user_id}/beta_migration_request")
  end

  # The branch of a GitHub repository. Useful for obtaining information about the last build on a given branch.
  #
  # **If querying using the repository slug, it must be formatted using {http://www.w3schools.com/tags/ref_urlencode.asp standard URL encoding}, including any special characters.**
  #
  # ## Attributes
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #     Name  Type    Description
  #     name  String  Name of the git branch.
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is {https://developer.travis-ci.com/eager-loading eager loaded}.
  #
  #     Name              Type        Description
  #     name              String      Name of the git branch.
  #     repository        Repository  GitHub user or organization the branch belongs to.
  #     default_branch    Boolean     Whether or not this is the resposiotry's default branch.
  #     exists_on_github  Boolean     Whether or not the branch still exists on GitHub.
  #     last_build        Build       Last build on the branch.
  #
  # **Additional Attributes**
  #
  #     Name           Type     Description
  #     recent_builds  [Build]  Last 10 builds on the branch (when `include=branch.recent_builds` is used).
  #
  # ## Actions
  #
  # **Find**
  #
  # This will return information about an individual branch. The request can include either the repository id or slug.
  #
  # GET <code>/repo/{repository.id}/branch/{branch.name}</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     branch.name        String   Name of the git branch.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /repo/891/branch/master
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.branch('master')
  # ```
  #
  # GET <code>/repo/{repository.slug}/branch/{branch.name}</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     branch.name        String  Name of the git branch.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /repo/rails%2Frails/branch/master
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.branch('master')
  # ```
  #
  # @param name [String] the branch name for the current repository
  # @return [Success, RequestError]
  def branch(name)
    get("#{with_repo}/branch/#{name}")
  end

  # A list of branches.
  #
  # **If querying using the repository slug, it must be formatted using {http://www.w3schools.com/tags/ref_urlencode.asp standard URL encoding}, including any special characters.**
  #
  # ##Attributes
  #
  #     Name      Type      Description
  #     branches  [Branch]  List of branches.
  #
  # **Collection Items**
  #
  # Each entry in the **branches** array has the following attributes:
  #
  #     Name              Type        Description
  #     name              String      Name of the git branch.
  #     repository        Repository  GitHub user or organization the branch belongs to.
  #     default_branch    Boolean     Whether or not this is the resposiotry's default branch.
  #     exists_on_github  Boolean     Whether or not the branch still exists on GitHub.
  #     last_build        Build       Last build on the branch.
  #     recent_builds    [Build]      Last 10 builds on the branch (when `include=branch.recent_builds` is used).
  #
  # ## Actions
  #
  # **Find**
  #
  # This will return a list of branches a repository has on GitHub.
  #
  # GET <code>/repo/{repository.id}/branches</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     Query Parameter          Type       Description
  #     branch.exists_on_github  [Boolean]  Filters branches by whether or not the branch still exists on GitHub.
  #     exists_on_github         [Boolean]  Alias for branch.exists_on_github.
  #     include                  [String]   List of attributes to eager load.
  #     limit                    Integer    How many branches to include in the response. Used for pagination.
  #     offset                   Integer    How many branches to skip before the first entry in the response. Used for pagination.
  #     sort_by                  [String]   Attributes to sort branches by. Used for pagination.
  #
  #     Example: GET /repo/891/branches?limit=5&exists_on_github=true
  #
  # **Sortable by:** <code>name</code>, <code>last_build</code>, <code>exists_on_github</code>, <code>default_branch</code>, append <code>:desc</code> to any attribute to reverse order.
  # The default value is <code>default_branch</code>,<code>exists_on_github</code>,<code>last_build:desc</code>.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.options.build({limit: 5, exists_on_github: true})
  # travis.branches
  # ```
  #
  # GET <code>/repo/{repository.slug}/branches</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     Query Parameter          Type       Description
  #     branch.exists_on_github  [Boolean]  Filters branches by whether or not the branch still exists on GitHub.
  #     exists_on_github         [Boolean]  Alias for branch.exists_on_github.
  #     include                  [String]   List of attributes to eager load.
  #     limit                    Integer    How many branches to include in the response. Used for pagination.
  #     offset                   Integer    How many branches to skip before the first entry in the response. Used for pagination.
  #     sort_by                  [String]   Attributes to sort branches by. Used for pagination.
  #
  #     Example: GET /repo/rails%2Frails/branches?limit=5&exists_on_github=true
  #
  # **Sortable by:** <code>name</code>, <code>last_build</code>, <code>exists_on_github</code>, <code>default_branch</code>, append <code>:desc</code> to any attribute to reverse order.
  # The default value is <code>default_branch</code>,<code>exists_on_github</code>,<code>last_build:desc</code>.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.options.build({limit: 5, exists_on_github: true})
  # travis.branches
  # ```
  #
  # @return [Success, RequestError]
  def branches
    get("#{with_repo}/branches#{opts}")
  end

  # A list of broadcasts for the current user.
  #
  # ## Attributes
  #
  #     Name        Type         Description
  #     broadcasts  [Broadcast]  List of broadcasts.
  #
  # **Collection Items**
  #
  # Each entry in the broadcasts array has the following attributes:
  #
  #     Name        Type     Description
  #     id          Integer  Value uniquely identifying the broadcast.
  #     message     String   Message to display to the user.
  #     created_at  String   When the broadcast was created.
  #     category    String   Broadcast category (used for icon and color).
  #     active      Boolean  Whether or not the brodacast should still be displayed.
  #     recipient   Object   Either a user, organization or repository, or null for global.
  #
  # ## Actions
  #
  # **For Current User**
  #
  # This will return a list of broadcasts for the current user.
  #
  # GET <code>/broadcasts</code>
  #
  #     Query Parameter   Type       Description
  #     active            [Boolean]  Alias for broadcast.active.
  #     broadcast.active  [Boolean]  Filters broadcasts by whether or not the brodacast should still be displayed.
  #     include           [String]   List of attributes to eager load.
  #
  #     Example: GET /broadcasts
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.broadcasts
  # ```
  #
  # @note requests require an authorization token set in the headers. See: {authorization=}
  #
  # @return [Success, RequestError]
  def broadcasts
    get("#{without_repo}/broadcasts")
  end

  # An individual build.
  #
  # ## Attributes
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #     Name                 Type     Description
  #     id                   Integer  Value uniquely identifying the build.
  #     number               String   Incremental number for a repository's builds.
  #     state                String   Current state of the build.
  #     duration             Integer  Wall clock time in seconds.
  #     event_type           String   Event that triggered the build.
  #     previous_state       String   State of the previous build (useful to see if state changed).
  #     pull_request_title   String   Title of the build's pull request.
  #     pull_request_number  Integer  Number of the build's pull request.
  #     started_at           String   When the build started.
  #     finished_at          String   When the build finished.
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is eager loaded.
  #
  #     Name                 Type        Description
  #     id                   Integer     Value uniquely identifying the build.
  #     number               String      Incremental number for a repository's builds.
  #     state                String      Current state of the build.
  #     duration             Integer     Wall clock time in seconds.
  #     event_type           String      Event that triggered the build.
  #     previous_state       String      State of the previous build (useful to see if state changed).
  #     pull_request_title   String      Title of the build's pull request.
  #     pull_request_number  Integer     Number of the build's pull request.
  #     started_at           String      When the build started.
  #     finished_at          String      When the build finished.
  #     repository           Repository  GitHub user or organization the build belongs to.
  #     branch               Branch      The branch the build is associated with.
  #     tag                  Unknown     The build's tag.
  #     commit               Commit      The commit the build is associated with.
  #     jobs                 Jobs        List of jobs that are part of the build's matrix.
  #     stages               [Stage]     The stages of a build.
  #     created_by           Owner       The User or Organization that created the build.
  #     updated_at           Unknown     The build's updated_at.
  #
  # ## Actions
  #
  # **Find**
  #
  # This returns a single build.
  #
  # GET <code>/build/{build.id}</code>
  #
  #     Template Variable  Type     Description
  #     build.id           Integer  Value uniquely identifying the build.
  #
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /build/86601346
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.build(351_778_872)
  # ```
  #
  # **Cancel**
  #
  # This cancels a currently running build. It will set the build and associated jobs to "state": "canceled".
  #
  # POST <code>/build/{build.id}/cancel</code>
  #
  #     Template Variable  Type     Description
  #     build.id           Integer  Value uniquely identifying the build.
  #
  #     Example: POST /build/86601346/cancel
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.build(478_772_528, :cancel)
  # ```
  #
  # **Restart**
  #
  # This restarts a build that has completed or been canceled.
  #
  # POST <code>/build/{build.id}/restart</code>
  #
  #     Template Variable  Type     Description
  #     build.id           Integer  Value uniquely identifying the build.
  #
  #     Example: POST /build/86601346/restart
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.build(478_772_528, :restart)
  # ```
  #
  # @note POST requests require an authorization token set in the headers. See: {authorization=}
  #
  # @param build_id [String, Integer] the build id number
  # @param option [Symbol] options for :cancel or :restart
  # @raise [TypeError] if given build id is not a number
  # @return [Success, RequestError]
  def build(build_id, option = nil)
    validate_number build_id

    case option
    when :cancel
      post("#{without_repo}/build/#{build_id}/cancel")
    when :restart
      post("#{without_repo}/build/#{build_id}/restart")
    else
      get("#{without_repo}/build/#{build_id}")
    end
  end

  # A list of builds.
  #
  # ## Attributes
  #
  #     Name    Type     Description
  #     builds  [Build]  List of builds.
  #
  # **Collection Items**
  #
  # Each entry in the builds array has the following attributes:
  #
  #     Name                 Type        Description
  #     id                   Integer     Value uniquely identifying the build.
  #     number               String      Incremental number for a repository's builds.
  #     state                String      Current state of the build.
  #     duration             Integer     Wall clock time in seconds.
  #     event_type           String      Event that triggered the build.
  #     previous_state       String      State of the previous build (useful to see if state changed).
  #     pull_request_title   String      Title of the build's pull request.
  #     pull_request_number  Integer     Number of the build's pull request.
  #     started_at           String      When the build started.
  #     finished_at          String      When the build finished.
  #     repository           Repository  GitHub user or organization the build belongs to.
  #     branch               Branch      The branch the build is associated with.
  #     tag                  Unknown     The build's tag.
  #     commit               Commit      The commit the build is associated with.
  #     jobs                 Jobs        List of jobs that are part of the build's matrix.
  #     stages               [Stage]     The stages of a build.
  #     created_by           Owner       The User or Organization that created the build.
  #     updated_at           Unknown     The build's updated_at.
  #     request              Unknown     The build's request.
  #
  # ## Actions
  #
  # **For Current User**
  #
  # This returns a list of builds for the current user. The result is paginated.
  #
  # GET <code>/builds</code>
  #
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #     limit            Integer   How many builds to include in the response. Used for pagination.
  #     offset           Integer   How many builds to skip before the first entry in the response. Used for pagination.
  #     sort_by          [String]  Attributes to sort builds by. Used for pagination.
  #
  #     Example: GET /builds?limit=5
  #
  # **Sortable by:** <code>id</code>, <code>started_at</code>, <code>finished_at</code>, append <code>:desc</code> to any attribute to reverse order.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.options.build({limit: 5})
  # travis.builds(false)
  # ```
  #
  # **Find**
  #
  # This returns a list of builds for an individual repository. It is possible to use the repository id or slug in the request. The result is paginated. Each request will return 25 results.
  #
  # GET <code>/repo/{repository.id}/builds</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #
  #     Query Parameter       Type      Description
  #     branch.name           [String]  Filters builds by name of the git branch.
  #     build.created_by      [Owner]   Filters builds by the User or Organization that created the build.
  #     build.event_type      [String]  Filters builds by event that triggered the build.
  #     build.previous_state  [String]  Filters builds by state of the previous build (useful to see if state changed).
  #     build.state           [String]  Filters builds by current state of the build.
  #     created_by            [Owner]   Alias for build.created_by.
  #     event_type            [String]  Alias for build.event_type.
  #     include               [String]  List of attributes to eager load.
  #     limit                 Integer   How many builds to include in the response. Used for pagination.
  #     offset                Integer   How many builds to skip before the first entry in the response. Used for pagination.
  #     previous_state        [String]  Alias for build.previous_state.
  #     sort_by               [String]  Attributes to sort builds by. Used for pagination.
  #     state                 [String]  Alias for build.state.
  #
  #     Example: GET /repo/891/builds?limit=5
  #
  # **Sortable by:** <code>id</code>, <code>started_at</code>, <code>finished_at</code>, append <code>:desc</code> to any attribute to reverse order.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.options.build({limit: 5})
  # travis.builds
  # ```
  #
  # GET <code>/repo/{repository.slug}/builds</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #
  #     Query Parameter       Type      Description
  #     branch.name           [String]  Filters builds by name of the git branch.
  #     build.created_by      [Owner]   Filters builds by the User or Organization that created the build.
  #     build.event_type      [String]  Filters builds by event that triggered the build.
  #     build.previous_state  [String]  Filters builds by state of the previous build (useful to see if state changed).
  #     build.state           [String]  Filters builds by current state of the build.
  #     created_by            [Owner]   Alias for build.created_by.
  #     event_type            [String]  Alias for build.event_type.
  #     include               [String]  List of attributes to eager load.
  #     limit                 Integer   How many builds to include in the response. Used for pagination.
  #     offset                Integer   How many builds to skip before the first entry in the response. Used for pagination.
  #     previous_state        [String]  Alias for build.previous_state.
  #     sort_by               [String]  Attributes to sort builds by. Used for pagination.
  #     state                 [String]  Alias for build.state.
  #
  #     Example: GET /repo/rails%2Frails/builds?limit=5
  #
  # **Sortable by:** <code>id</code>, <code>started_at</code>, <code>finished_at</code>, append <code>:desc</code> to any attribute to reverse order.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.options.build({limit: 5})
  # travis.builds
  # ```
  #
  # @note requests may require an authorization token set in the headers. See: {authorization=}
  #
  # @param repo [Boolean] If true get repo builds, otherwise get user builds
  # @return [Success, RequestError]
  def builds(repo = true)
    repo and return get("#{with_repo}/builds#{opts}")
    get("#{without_repo}/builds#{opts}")
  end

  # A list of jobs.
  #
  # ## Attributes
  #
  #     Name  Type  Description
  #     jobs  [Job]  List of jobs.
  #
  # **Collection Items**
  #
  # Each entry in the jobs array has the following attributes:
  #
  #     Name           Type        Description
  #     id             Integer     Value uniquely identifying the job.
  #     allow_failure  Unknown     The job's allow_failure.
  #     number         String      Incremental number for a repository's builds.
  #     state          String      Current state of the job.
  #     started_at     String      When the job started.
  #     finished_at    String      When the job finished.
  #     build          Build       The build the job is associated with.
  #     queue          String      Worker queue this job is/was scheduled on.
  #     repository     Repository  GitHub user or organization the job belongs to.
  #     commit         Commit      The commit the job is associated with.
  #     owner          Owner       GitHub user or organization the job belongs to.
  #     stage          [Stage]     The stages of a job.
  #     created_at     String      When the job was created.
  #     updated_at     String      When the job was updated.
  #     config         Object      The job's config.
  #
  # ## Actions
  #
  # **Find**
  #
  # This returns a list of jobs belonging to an individual build.
  #
  # GET <code>/build/{build.id}/jobs</code>
  #
  #     Template Variable  Type     Description
  #     build.id           Integer  Value uniquely identifying the build.
  #
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /build/86601346/jobs
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.build_jobs(86_601_346)
  # ```
  #
  # **For Current User**
  #
  # This returns a list of jobs a current user has access to.
  #
  # GET <code>/jobs</code>
  #
  #     Query Parameter  Type      Description
  #     active           Unknown   Alias for job.active.
  #     created_by       Unknown   Alias for job.created_by.
  #     include          [String]  List of attributes to eager load.
  #     job.active       Unknown   Documentation missing.
  #     job.created_by   Unknown   Documentation missing.
  #     job.state        [String]  Filters jobs by current state of the job.
  #     limit            Integer   How many jobs to include in the response. Used for pagination.
  #     offset           Integer   How many jobs to skip before the first entry in the response. Used for pagination.
  #     sort_by          [String]  Attributes to sort jobs by. Used for pagination.
  #     state            [String]  Alias for job.state.
  #
  #     Example: GET /jobs?limit=5
  #
  # **Sortable by:** <code>id</code>, append <code>:desc</code> to any attribute to reverse order.
  # The default value is id:desc.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.options.build({limit: 5})
  # travis.build_jobs(false)
  # ```
  #
  # @note requests may require an authorization token set in the headers. See: {authorization=}
  #
  # @param build_id [String, Integer, Boolean] the build id number.  If falsey then get all jobs for current user
  # @return [Success, RequestError]
  def build_jobs(build_id)
    build_id and return get("#{without_repo}/build/#{build_id}/jobs")
    get("#{without_repo}/jobs#{opts}")
  end

  # A list of caches.
  #
  # If querying using the repository slug, it must be formatted using {http://www.w3schools.com/tags/ref_urlencode.asp standard URL encoding}, including any special characters.
  #
  # ## Attributes
  #
  #     Name    Type    Description
  #     branch  String  The branch the cache belongs to.
  #     match   String  The string to match against the cache name.
  #
  # ## Actions
  #
  # **Find**
  #
  # This returns all the caches for a repository.
  #
  # It's possible to filter by branch or by regexp match of a string to the cache name.
  #
  # ```bash
  # curl \
  #   -H "Content-Type: application/json" \
  #   -H "Travis-API-Version: 3" \
  #   -H "Authorization: token xxxxxxxxxxxx" \
  #   https://api.travis-ci.com/repo/1234/caches?branch=master
  # ```
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.options.build({branch: :master})
  # travis.caches
  # ```
  #
  # ```bash
  # curl \
  #   -H "Content-Type: application/json" \
  #   -H "Travis-API-Version: 3" \
  #   -H "Authorization: token xxxxxxxxxxxx" \
  #   https://api.travis-ci.com/repo/1234/caches?match=linux
  # ```
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.options.build({match: :linux})
  # travis.caches
  # ```
  #
  # GET <code>/repo/{repository.id}/caches</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     Query Parameter  Type      Description
  #     branch           [String]  Alias for caches.branch.
  #     caches.branch    [String]  Filters caches by the branch the cache belongs to.
  #     caches.match     [String]  Filters caches by the string to match against the cache name.
  #     include          [String]  List of attributes to eager load.
  #     match            [String]  Alias for caches.match.
  #
  #     Example: GET /repo/891/caches
  #
  # GET <code>/repo/{repository.slug}/caches</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     Query Parameter  Type      Description
  #     branch           [String]  Alias for caches.branch.
  #     caches.branch    [String]  Filters caches by the branch the cache belongs to.
  #     caches.match     [String]  Filters caches by the string to match against the cache name.
  #     include          [String]  List of attributes to eager load.
  #     match            [String]  Alias for caches.match.
  #
  #     Example: GET /repo/rails%2Frails/caches
  #
  # **Delete**
  #
  # This deletes all caches for a repository.
  #
  # As with `find` it's possible to delete by branch or by regexp match of a string to the cache name.
  #
  # ```bash
  # curl -X DELETE \
  #   -H "Content-Type: application/json" \
  #   -H "Travis-API-Version: 3" \
  #   -H "Authorization: token xxxxxxxxxxxx" \
  #   https://api.travis-ci.com/repo/1234/caches?branch=master
  # ```
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.options.build({branch: :master})
  # travis.caches(:delete)
  # ```
  #
  # DELETE <code>/repo/{repository.id}/caches</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #
  #     Example: DELETE /repo/891/caches
  #
  # DELETE <code>/repo/{repository.slug}/caches</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #
  #     Example: DELETE /repo/rails%2Frails/caches
  #
  # @note DELETE requests require an authorization token set in the headers. See: {authorization=}
  #
  # @param delete [Boolean] option for deleting cache(s)
  # @return [Success, RequestError]
  def caches(delete = false)
    without_limit do
      :delete.==(delete) and return delete("#{with_repo}/caches#{opts}")
      get("#{with_repo}/caches#{opts}")
    end
  end

  # An individual cron. There can be only one cron per branch on a repository.
  #
  # If querying using the repository slug, it must be formatted using {http://www.w3schools.com/tags/ref_urlencode.asp standard URL encoding}, including any special characters.
  #
  # ## Attributes
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #     Name  Type     Description
  #     id    Integer  Value uniquely identifying the cron.
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is {https://developer.travis-ci.com/eager-loading eager loaded}.
  #
  #     Name                             Type        Description
  #     id                               Integer     Value uniquely identifying the cron.
  #     repository                       Repository  Github repository to which this cron belongs.
  #     branch                           Branch      Git branch of repository to which this cron belongs.
  #     interval                         String      Interval at which the cron will run (can be "daily", "weekly" or "monthly").
  #     dont_run_if_recent_build_exists  Boolean     Whether a cron build should run if there has been a build on this branch in the last 24 hours.
  #     last_run                         String      When the cron ran last.
  #     next_run                         String      When the cron is scheduled to run next.
  #     created_at                       String      When the cron was created.
  #     active                           Unknown     The cron's active.
  #
  # ## Actions
  #
  # **Find**
  #
  # This returns a single cron.
  #
  # GET <code>/cron/{cron.id}</code>
  #
  #     Template Variable  Type     Description
  #     cron.id            Integer  Value uniquely identifying the cron.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.cron(id: 78_199)
  # ```
  #
  # **Delete**
  #
  # This deletes a single cron.
  #
  # DELETE <code>/cron/{cron.id}</code>
  #
  #     Template Variable  Type     Description
  #     cron.id            Integer  Value uniquely identifying the cron.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.cron(id: 78_199, delete: true)
  # ```
  #
  # **For Branch**
  #
  # This returns the cron set for the specified branch for the specified repository. It is possible to use the repository id or slug in the request.
  #
  # GET <code>/repo/{repository.id}/branch/{branch.name}/cron</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     branch.name        String   Name of the git branch.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /repo/891/branch/master/cron
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.cron(branch_name: 'master')
  # ```
  #
  # GET <code>/repo/{repository.slug}/branch/{branch.name}/cron</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     branch.name        String  Name of the git branch.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /repo/rails%2Frails/branch/master/cron
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.cron(branch_name: 'master')
  # ```
  #
  # **Create**
  #
  # This creates a cron on the specified branch for the specified repository. It is possible to use the repository id or slug in the request. Content-Type MUST be set in the header and an interval for the cron MUST be specified as a parameter.
  #
  # ```bash
  # curl -X POST \
  #   -H "Content-Type: application/json" \
  #   -H "Travis-API-Version: 3" \
  #   -H "Authorization: token xxxxxxxxxxxx" \
  #   -d '{ "cron.interval": "monthly" }' \
  #   https://api.travis-ci.com/repo/1234/branch/master/cron
  # ```
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.cron(branch_name: 'master', create: { 'interval' => 'monthly' })
  # ```
  #
  # POST <code>/repo/{repository.id}/branch/{branch.name}/cron</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     branch.name        String   Name of the git branch.
  #     Accepted Parameter                    Type     Description
  #     cron.interval                         String   Interval at which the cron will run (can be "daily", "weekly" or "monthly").
  #     cron.dont_run_if_recent_build_exists  Boolean  Whether a cron build should run if there has been a build on this branch in the last 24 hours.
  #
  #     Example: POST /repo/891/branch/master/cron
  #
  # POST <code>/repo/{repository.slug}/branch/{branch.name}/cron</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     branch.name        String  Name of the git branch.
  #     Accepted Parameter                    Type     Description
  #     cron.interval                         String   Interval at which the cron will run (can be "daily", "weekly" or "monthly").
  #     cron.dont_run_if_recent_build_exists  Boolean  Whether a cron build should run if there has been a build on this branch in the last 24 hours.
  #
  #     Example: POST /repo/rails%2Frails/branch/master/cron
  #
  # @param id [String, Integer] cron id to get or delete
  # @param branch_name [String] branch name to get cron or create
  # @param create [Hash] Properties for creating the cron.  `branch_name` keyword argument required and `interval` key/value required.
  # @param delete [Boolean] option for deleting cron.  Cron `id` keyword argument required.
  # @return [Success, RequestError]
  def cron(id: nil, branch_name: nil, create: nil, delete: false)
    if id
      validate_number id

      delete and return delete("#{without_repo}/cron/#{id}")
      return get("#{without_repo}/cron/#{id}")
    end
    raise ArgumentError, 'id or branch_name required' unless branch_name

    create and return create("#{with_repo}/branch/#{branch_name}/cron", cron_keys(create))
    get("#{with_repo}/branch/#{branch_name}/cron")
  end

  # A list of crons.
  #
  # If querying using the repository slug, it must be formatted using {http://www.w3schools.com/tags/ref_urlencode.asp standard URL encoding}, including any special characters.
  #
  # ## Attributes
  #
  #     Name   Type    Description
  #     crons  [Cron]  List of crons.
  #
  # **Collection Items**
  #
  # Each entry in the crons array has the following attributes:
  #
  #     Name                             Type        Description
  #     id                               Integer     Value uniquely identifying the cron.
  #     repository                       Repository  Github repository to which this cron belongs.
  #     branch                           Branch      Git branch of repository to which this cron belongs.
  #     interval                         String      Interval at which the cron will run (can be "daily", "weekly" or "monthly").
  #     dont_run_if_recent_build_exists  Boolean     Whether a cron build should run if there has been a build on this branch in the last 24 hours.
  #     last_run                         String      When the cron ran last.
  #     next_run                         String      When the cron is scheduled to run next.
  #     created_at                       String      When the cron was created.
  #     active                           Unknown     The cron's active.
  #
  # ## Actions
  #
  # **For Repository**
  #
  # This returns a list of crons for an individual repository. It is possible to use the repository id or slug in the request.
  #
  # GET <code>/repo/{repository.id}/crons</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #     limit            Integer   How many crons to include in the response. Used for pagination.
  #     offset           Integer   How many crons to skip before the first entry in the response. Used for pagination.
  #
  #     Example: GET /repo/891/crons?limit=5
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.options.build({limit: 5})
  # travis.crons
  # ```
  #
  # GET <code>/repo/{repository.slug}/crons</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #     limit            Integer   How many crons to include in the response. Used for pagination.
  #     offset           Integer   How many crons to skip before the first entry in the response. Used for pagination.
  #
  #     Example: GET /repo/rails%2Frails/crons?limit=5
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.options.build({limit: 5})
  # travis.crons
  # ```
  #
  # @return [Success, RequestError]
  def crons
    get("#{with_repo}/crons#{opts}")
  end

  # POST <code>/repo/{repository.id}/email_subscription</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #
  #     Example: POST /repo/891/email_subscription
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.email_resubscribe
  # ```
  #
  # POST <code>/repo/{repository.slug}/email_subscription</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #
  #     Example: POST /repo/rails%2Frails/email_subscription
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.email_resubscribe
  # ```
  #
  # @note requests require an authorization token set in the headers. See: {authorization=}
  #
  # @return [Success, RequestError]
  def email_resubscribe
    post("#{with_repo}/email_subscription")
  end

  # DELETE <code>/repo/{repository.id}/email_subscription</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #
  #     Example: DELETE /repo/891/email_subscription
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.email_unsubscribe
  # ```
  #
  # DELETE <code>/repo/{repository.slug}/email_subscription</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #
  #     Example: DELETE /repo/rails%2Frails/email_subscription
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.email_unsubscribe
  # ```
  #
  # @note requests require an authorization token set in the headers. See: {authorization=}
  #
  # @return [Success, RequestError]
  def email_unsubscribe
    delete("#{with_repo}/email_subscription")
  end

  # An individual environment variable.
  #
  # **If querying using the repository slug, it must be formatted using {http://www.w3schools.com/tags/ref_urlencode.asp standard URL encoding}, including any special characters.**
  #
  # ## Attributes
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is {https://developer.travis-ci.com/eager-loading eager loaded}.
  #
  #     Name    Type     Description
  #     id      String   The environment variable id.
  #     name    String   The environment variable name, e.g. FOO.
  #     value   String   The environment variable's value, e.g. bar.
  #     public  Boolean  Whether this environment variable should be publicly visible or not.
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #     Name    Type     Description
  #     id      String   The environment variable id.
  #     name    String   The environment variable name, e.g. FOO.
  #     public  Boolean  Whether this environment variable should be publicly visible or not.
  #
  # ## Actions
  #
  # **Find**
  #
  # This returns a single environment variable. It is possible to use the repository id or slug in the request.
  #
  # GET <code>/repo/{repository.id}/env_var/{env_var.id}</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     env_var.id         String   The environment variable id.
  #     Query Parameter  Type      Description
  #     env_var.id       String    The environment variable id.
  #     id               String    Alias for env_var.id.
  #     include          [String]  List of attributes to eager load.
  #     repository.id    Integer   Value uniquely identifying the repository.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.env_var('76f9d8bd-642d-47ed-9f35-4c25eb030c6c')
  # ```
  #
  # GET <code>/repo/{repository.slug}/env_var/{env_var.id}</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     env_var.id         String  The environment variable id.
  #     Query Parameter  Type      Description
  #     env_var.id       String    The environment variable id.
  #     id               String    Alias for env_var.id.
  #     include          [String]  List of attributes to eager load.
  #     repository.id    Integer   Value uniquely identifying the repository.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.env_var('76f9d8bd-642d-47ed-9f35-4c25eb030c6c')
  # ```
  #
  # **Update**
  #
  # This updates a single environment variable. It is possible to use the repository id or slug in the request.
  #
  # Use namespaced params in the request body to pass the new environment variable:
  #
  # ```bash
  # curl -X PATCH \
  #   -H "Content-Type: application/json" \
  #   -H "Travis-API-Version: 3" \
  #   -H "Authorization: token xxxxxxxxxxxx" \
  #   -d '{ "env_var.value": "bar", "env_var.public": false }' \
  #   https://api.travis-ci.com/repo/1234/{env_var.id}
  # ```
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.env_var('76f9d8bd-642d-47ed-9f35-4c25eb030c6c', update: { value: 'bar', public: false })
  # ```
  #
  # PATCH <code>/repo/{repository.id}/env_var/{env_var.id}</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     env_var.id         String   The environment variable id.
  #     Accepted Parameter  Type     Description
  #     env_var.name        String   The environment variable name, e.g. FOO.
  #     env_var.value       String   The environment variable's value, e.g. bar.
  #     env_var.public      Boolean  Whether this environment variable should be publicly visible or not.
  #
  # PATCH <code>/repo/{repository.slug}/env_var/{env_var.id}</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     env_var.id         String  The environment variable id.
  #     Accepted Parameter  Type     Description
  #     env_var.name        String   The environment variable name, e.g. FOO.
  #     env_var.value       String   The environment variable's value, e.g. bar.
  #     env_var.public      Boolean  Whether this environment variable should be publicly visible or not.
  #
  # **Delete**
  #
  # This deletes a single environment variable. It is possible to use the repository id or slug in the request.
  #
  # DELETE <code>/repo/{repository.id}/env_var/{env_var.id}</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     env_var.id         String   The environment variable id.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.env_var('76f9d8bd-642d-47ed-9f35-4c25eb030c6c', delete: true)
  # ```
  #
  # DELETE <code>/repo/{repository.slug}/env_var/{env_var.id}</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     env_var.id         String  The environment variable id.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.env_var('76f9d8bd-642d-47ed-9f35-4c25eb030c6c', delete: true)
  # ```
  #
  # @overload env_var(env_var_id)
  #   Gets current env var
  #   @param env_var_id [String] environment variable id
  # @overload env_var(env_var_id, action: params)
  #   Performs action per specific key word argument
  #   @param env_var_id [String] environment variable id
  #   @param update [Hash] Optional keyword argument. Update key pair with hash `{ value: "new value" }`
  #   @param delete [Boolean] Optional keyword argument. Use truthy value to delete current key pair
  # @return [Success, RequestError]
  def env_var(env_var_id, update: nil, delete: nil)
    raise 'Too many options specified' unless [update, delete].compact.count < 2

    validate_string env_var_id

    update and return patch("#{with_repo}/env_var/#{env_var_id}", env_var_keys(update))
    delete and return delete("#{with_repo}/env_var/#{env_var_id}")
    get("#{with_repo}/env_var/#{env_var_id}")
  end

  # A list of environment variables.
  #
  # **If querying using the repository slug, it must be formatted using {http://www.w3schools.com/tags/ref_urlencode.asp standard URL encoding}, including any special characters.**
  #
  # ## Attributes
  #
  #     Name      Type       Description
  #     env_vars  [Env var]  List of env_vars.
  #
  # ## Actions
  #
  # **For Repository**
  #
  # This returns a list of environment variables for an individual repository. It is possible to use the repository id or slug in the request.
  #
  # GET <code>/repo/{repository.id}/env_vars</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /repo/891/env_vars
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.env_vars
  # ```
  #
  # GET <code>/repo/{repository.slug}/env_vars</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /repo/rails%2Frails/env_vars
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.env_vars
  # ```
  #
  # **Create**
  #
  # This creates an environment variable for an individual repository. It is possible to use the repository id or slug in the request.
  #
  # Use namespaced params in the request body to pass the new environment variables:
  #
  # ```bash
  # curl -X POST \
  #   -H "Content-Type: application/json" \
  #   -H "Travis-API-Version: 3" \
  #   -H "Authorization: token xxxxxxxxxxxx" \
  #   -d '{ "env_var.name": "FOO", "env_var.value": "bar", "env_var.public": false }' \
  #   https://api.travis-ci.com/repo/1234/env_vars
  # ```
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.env_vars(name: 'FOO', value: 'bar', public: false)
  # ```
  #
  # POST <code>/repo/{repository.id}/env_vars</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     Accepted Parameter  Type     Description
  #     env_var.name        String   The environment variable name, e.g. FOO.
  #     env_var.value       String   The environment variable's value, e.g. bar.
  #     env_var.public      Boolean  Whether this environment variable should be publicly visible or not.
  #
  #     Example: POST /repo/891/env_vars
  #
  # POST <code>/repo/{repository.slug}/env_vars</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     Accepted Parameter  Type     Description
  #     env_var.name        String   The environment variable name, e.g. FOO.
  #     env_var.value       String   The environment variable's value, e.g. bar.
  #     env_var.public      Boolean  Whether this environment variable should be publicly visible or not.
  #
  #     Example: POST /repo/rails%2Frails/env_vars
  #
  # @note requests require an authorization token set in the headers. See: {authorization=}
  #
  # @param create [Hash] Optional argument.  A hash of the `name`, `value`, and `public` visibleness for a env var to create
  # @return [Success, RequestError]
  def env_vars(create = nil)
    create and return create("#{with_repo}/env_vars", env_var_keys(create))
    get("#{with_repo}/env_vars")
  end

  # A GitHub App installation.
  #
  # ## Attributes
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #     Name       Type     Description
  #     id         Integer  The installation id.
  #     github_id  Integer  The installation's id on GitHub.
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is {https://developer.travis-ci.com/eager-loading eager loaded}.
  #
  #     Name       Type     Description
  #     id         Integer  The installation id.
  #     github_id  Integer  The installation's id on GitHub.
  #     owner      Owner    GitHub user or organization the installation belongs to.
  #
  # ## Actions
  #
  # **Find**
  #
  # This returns a single installation.
  #
  # GET <code>/installation/{installation.github_id}</code>
  #
  #     Template Variable       Type     Description
  #     installation.github_id  Integer  The installation's id on GitHub.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.api_endpoint = 'https://api.travis-ci.com'
  # travis.authorization = 'xxxx'
  # travis.installation(617_754)
  # ```
  #
  # @param installation_id [String, Integer] GitHub App installation id
  # @return [Success, RequestError]
  def installation(installation_id)
    validate_number installation_id

    get("#{without_repo}/installation/#{installation_id}")
  end

  # An individual job.
  #
  # ## Attributes
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #     Name  Type     Description
  #     id    Integer  Value uniquely identifying the job.
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is eager loaded.
  #
  #     Name           Type        Description
  #     id             Integer     Value uniquely identifying the job.
  #     allow_failure  Unknown     The job's allow_failure.
  #     number         String      Incremental number for a repository's builds.
  #     state          String      Current state of the job.
  #     started_at     String      When the job started.
  #     finished_at    String      When the job finished.
  #     build          Build       The build the job is associated with.
  #     queue          String      Worker queue this job is/was scheduled on.
  #     repository     Repository  GitHub user or organization the job belongs to.
  #     commit         Commit      The commit the job is associated with.
  #     owner          Owner       GitHub user or organization the job belongs to.
  #     stage          [Stage]     The stages of a job.
  #     created_at     String      When the job was created.
  #     updated_at     String      When the job was updated.
  #
  # ## Actions
  #
  # **Find**
  #
  # This returns a single job.
  #
  # GET <code>/job/{job.id}</code>
  #
  #     Template Variable  Type     Description
  #     job.id             Integer  Value uniquely identifying the job.
  #
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /job/86601347
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.job(351_778_875)
  # ```
  #
  # **Cancel**
  #
  # This cancels a currently running job.
  #
  # POST <code>/job/{job.id}/cancel</code>
  #
  #     Template Variable  Type     Description
  #     job.id             Integer  Value uniquely identifying the job.
  #
  #     Example: POST /job/86601347/cancel
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.job(351_778_875, :cancel)
  # ```
  #
  # **Restart**
  #
  # This restarts a job that has completed or been canceled.
  #
  # POST <code>/job/{job.id}/restart</code>
  #
  #     Template Variable  Type     Description
  #     job.id             Integer  Value uniquely identifying the job.
  #
  #     Example: POST /job/86601347/restart
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.job(351_778_875, :restart)
  # ```
  #
  # **Debug**
  #
  # This restarts a job in debug mode, enabling the logged-in user to ssh into the build VM. Please note this feature is only available on the travis-ci.com domain, and those repositories on the travis-ci.org domain for which the debug feature is enabled. See this document for more details.
  #
  # POST <code>/job/{job.id}/debug</code>
  #
  #     Template Variable  Type     Description
  #     job.id             Integer  Value uniquely identifying the job.
  #
  #     Example: POST /job/86601347/debug
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.api_endpoint = 'https://api.travis-ci.com'
  # travis.authorization = 'xxxx'
  # travis.job(351_778_875, :debug)
  # ```
  #
  # @note POST requests require an authorization token set in the headers. See: {authorization=}
  # @note **Debug** is only available on the travis-ci.com domain, and those repositories on the travis-ci.org domain for which the debug feature is enabled.
  #
  # @param job_id [String, Integer] the job id number
  # @param option [Symbol] options for :cancel, :restart, or :debug
  # @return [Success, RequestError]
  def job(job_id, option = nil)
    case option
    when :cancel
      post("#{without_repo}/job/#{job_id}/cancel")
    when :restart
      post("#{without_repo}/job/#{job_id}/restart")
    when :debug
      post("#{without_repo}/job/#{job_id}/debug")
    else
      get("#{without_repo}/job/#{job_id}")
    end
  end

  # Users may add a public/private RSA key pair to a repository.
  # This can be used within builds, for example to access third-party services or deploy code to production.
  # Please note this feature is only available on the travis-ci.com domain.
  #
  # ## Attributes
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is {https://developer.travis-ci.com/eager-loading eager loaded}.
  #
  #     Name         Type    Description
  #     description  String  A text description.
  #     public_key   String  The public key.
  #     fingerprint  String  The fingerprint.
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #     Name         Type    Description
  #     description  String  A text description.
  #     public_key   String  The public key.
  #     fingerprint  String  The fingerprint.
  #
  # ## Actions
  #
  # **Find**
  #
  # Return the current key pair, if it exists.
  #
  # GET <code>/repo/{repository.id}/key_pair</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /repo/891/key_pair
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.api_endpoint = 'https://api.travis-ci.com'
  # travis.authorization = 'xxxx'
  # travis.key_pair
  # ```
  #
  # GET <code>/repo/{repository.slug}/key_pair</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /repo/rails%2Frails/key_pair
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.api_endpoint = 'https://api.travis-ci.com'
  # travis.authorization = 'xxxx'
  # travis.key_pair
  # ```
  #
  # **Create**
  #
  # Creates a new key pair.
  #
  # ```bash
  # curl -X POST \
  #   -H "Content-Type: application/json" \
  #   -H "Travis-API-Version: 3" \
  #   -H "Authorization: token xxxxxxxxxxxx" \
  #   -d '{ "key_pair.description": "FooBar", "key_pair.value": "xxxxx"}' \
  #   https://api.travis-ci.com/repo/1234/key_pair
  # ```
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.api_endpoint = 'https://api.travis-ci.com'
  # travis.authorization = 'xxxx'
  # travis.key_pair(create: { description: 'FooBar', value: OpenSSL::PKey::RSA.generate(2048).to_s })
  # ```
  #
  # POST <code>/repo/{repository.id}/key_pair</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     Accepted Parameter    Type    Description
  #     key_pair.description  String  A text description.
  #     key_pair.value        String  The private key.
  #
  #     Example: POST /repo/891/key_pair
  #
  # POST <code>/repo/{repository.slug}/key_pair</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     Accepted Parameter    Type    Description
  #     key_pair.description  String  A text description.
  #     key_pair.value        String  The private key.
  #
  #     Example: POST /repo/rails%2Frails/key_pair
  #
  # **Update**
  #
  # Update the key pair.
  #
  # ```bash
  # curl -X PATCH \
  #   -H "Content-Type: application/json" \
  #   -H "Travis-API-Version: 3" \
  #   -H "Authorization: token xxxxxxxxxxxx" \
  #   -d '{ "key_pair.description": "FooBarBaz" }' \
  #   https://api.travis-ci.com/repo/1234/key_pair
  # ```
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.api_endpoint = 'https://api.travis-ci.com'
  # travis.authorization = 'xxxx'
  # travis.key_pair(update: { description: 'FooBarBaz' })
  # ```
  #
  # PATCH <code>/repo/{repository.id}/key_pair</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     Accepted Parameter    Type    Description
  #     key_pair.description  String  A text description.
  #     key_pair.value        String  The private key.
  #
  #     Example: PATCH /repo/891/key_pair
  #
  # PATCH <code>/repo/{repository.slug}/key_pair</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     Accepted Parameter    Type    Description
  #     key_pair.description  String  A text description.
  #     key_pair.value        String  The private key.
  #
  #     Example: PATCH /repo/rails%2Frails/key_pair
  #
  # **Delete**
  #
  # Delete the key pair.
  #
  # DELETE <code>/repo/{repository.id}/key_pair</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #
  #     Example: DELETE /repo/891/key_pair
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.api_endpoint = 'https://api.travis-ci.com'
  # travis.authorization = 'xxxx'
  # travis.key_pair(delete: true)
  # ```
  #
  # DELETE <code>/repo/{repository.slug}/key_pair</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #
  #     Example: DELETE /repo/rails%2Frails/key_pair
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.api_endpoint = 'https://api.travis-ci.com'
  # travis.authorization = 'xxxx'
  # travis.key_pair(delete: true)
  # ```
  #
  # @note requests require an authorization token set in the headers. See: {authorization=}
  # @note API enpoint needs to be set to `https://api.travis-ci.com` See: {api_endpoint=}
  #
  # @overload key_pair()
  #   Gets current key_pair if any
  # @overload key_pair(action: params)
  #   Performs action per specific key word argument
  #   @param create [Hash] Optional keyword argument.  Create a new key pair from provided private key `{ description: "name", value: "private key" }`
  #   @param update [Hash] Optional keyword argument.  Update key pair with hash `{ description: "new name" }`
  #   @param delete [Boolean] Optional keyword argument.  Use truthy value to delete current key pair
  # @return [Success, RequestError]
  def key_pair(create: nil, update: nil, delete: nil)
    raise 'Too many options specified' unless [create, update, delete].compact.count < 2

    create and return create("#{with_repo}/key_pair", key_pair_keys(create))
    update and return patch("#{with_repo}/key_pair", key_pair_keys(update))
    delete and return delete("#{with_repo}/key_pair")
    get("#{with_repo}/key_pair")
  end

  # Every repository has an auto-generated RSA key pair. This is used when cloning the repository from GitHub and when encrypting/decrypting secure data for use in builds, e.g. via the Travis CI command line client.
  #
  # Users may read the public key and fingerprint via GET request, or generate a new key pair via POST, but otherwise this key pair cannot be edited or removed.
  #
  # ## Attributes
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is {https://developer.travis-ci.com/eager-loading eager loaded}.
  #
  #     Name         Type    Description
  #     description  String  A text description.
  #     public_key   String  The public key.
  #     fingerprint  String  The fingerprint.
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #     Name         Type    Description
  #     description  String  A text description.
  #     public_key   String  The public key.
  #     fingerprint  String  The fingerprint.
  #
  # ## Actions
  #
  # **Find**
  #
  # Return the current key pair.
  #
  # GET <code>/repo/{repository.id}/key_pair/generated</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /repo/891/key_pair/generated
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.api_endpoint = 'https://api.travis-ci.com'
  # travis.authorization = 'xxxx'
  # travis.key_pair_generated
  # ```
  #
  # GET <code>/repo/{repository.slug}/key_pair/generated</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /repo/rails%2Frails/key_pair/generated
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.api_endpoint = 'https://api.travis-ci.com'
  # travis.authorization = 'xxxx'
  # travis.key_pair_generated
  # ```
  #
  # **Create**
  #
  # Generate a new key pair, replacing the previous one.
  #
  # POST <code>/repo/{repository.id}/key_pair/generated</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #
  #     Example: POST /repo/891/key_pair/generated
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.api_endpoint = 'https://api.travis-ci.com'
  # travis.authorization = 'xxxx'
  # travis.key_pair_generated(:create)
  # ```
  #
  # POST <code>/repo/{repository.slug}/key_pair/generated</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #
  #     Example: POST /repo/rails%2Frails/key_pair/generated
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.api_endpoint = 'https://api.travis-ci.com'
  # travis.authorization = 'xxxx'
  # travis.key_pair_generated(:create)
  # ```
  #
  # @note requests require an authorization token set in the headers. See: {authorization=}
  #
  # @param action [String, Symbol] defaults to getting current key pair, use `:create` if you would like to generate a new key pair
  # @return [Success, RequestError]
  def key_pair_generated(action = :get)
    return post("#{with_repo}/key_pair/generated") if action.match?(/create/i)

    get("#{with_repo}/key_pair/generated")
  end

  # This validates the `.travis.yml` file and returns any warnings.
  #
  # The request body can contain the content of the .travis.yml file directly as a string, eg "foo: bar".
  #
  # ## Attributes
  #
  #     Name      Type   Description
  #     warnings  Array  An array of hashes with keys and warnings.
  #
  # ## Actions
  #
  # **Lint**
  #
  # POST <code>/lint</code>
  #
  #     Example: POST /lint
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.lint(File.read('.travis.yml'))
  # ```
  #
  # @param yaml_content [String] the contents for the file `.travis.yml`
  # @return [Success, RequestError]
  def lint(yaml_content)
    validate_string yaml_content

    ct = headers.remove(:'Content-Type')
    result = post("#{without_repo}/lint", yaml_content)
    h('Content-Type': ct) if ct
    result
  end

  # An individual log.
  #
  # ## Attributes
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #     Name  Type     Description
  #     id    Unknown  The log's id.
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is eager loaded.
  #
  #     Name       Type     Description
  #     id         Unknown  The log's id.
  #     content    Unknown  The log's content.
  #     log_parts  Unknown  The log's log_parts.
  #
  # ## Actions
  #
  # **Find**
  #
  # This returns a single log.
  #
  # It's possible to specify the accept format of the request as text/plain if required. This will return the content of the log as a single blob of text.
  #
  #     curl -H "Travis-API-Version: 3" \
  #       -H "Accept: text/plain" \
  #       -H "Authorization: token xxxxxxxxxxxx" \
  #       https://api.travis-ci.org/job/{job.id}/log
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.log(351_778_875)
  # # or
  # travis.log(351_778_875, :text)
  # ```
  #
  # The default response type is application/json, and will include additional meta data such as @type, @representation etc. (see [https://developer.travis-ci.org/format](https://developer.travis-ci.org/format)).
  #
  # GET <code>/job/{job.id}/log</code>
  #
  #     Template Variable  Type     Description
  #     job.id             Integer  Value uniquely identifying the job.
  #
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #     log.token        Unknown   Documentation missing.
  #
  #     Example: GET /job/86601347/log
  #
  # GET <code>/job/{job.id}/log.txt</code>
  #
  #     Template Variable  Type     Description
  #     job.id             Integer  Value uniquely identifying the job.
  #
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #     log.token        Unknown   Documentation missing.
  #
  #     Example: GET /job/86601347/log.txt
  #
  # **Delete**
  #
  # This removes the contents of a log. It gets replace with the message: Log removed by XXX at 2017-02-13 16:00:00 UTC.
  #
  #     curl -X DELETE \
  #       -H "Travis-API-Version: 3" \
  #       -H "Authorization: token xxxxxxxxxxxx" \
  #       https://api.travis-ci.org/job/{job.id}/log
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.log(478_772_530, :delete)
  # ```
  #
  # DELETE <code>/job/{job.id}/log</code>
  #
  #     Template Variable  Type     Description
  #     job.id             Integer  Value uniquely identifying the job.
  #
  #     Example: DELETE /job/86601347/log
  #
  # @param job_id [String, Integer] the job id number
  # @param option [Symbol] options for :text or :delete
  # @return [Success, String, RequestError]
  def log(job_id, option = nil)
    case option
    when :text
      get("#{without_repo}/job/#{job_id}/log.txt", true)
    when :delete
      delete("#{without_repo}/job/#{job_id}/log")
    else
      get("#{without_repo}/job/#{job_id}/log")
    end
  end

  # A list of messages. Messages belong to resource types.
  #
  # ## Attributes
  #
  #     Name      Type       Description
  #     messages  [Message]  List of messages.
  #
  # **Collection Items**
  #
  # Each entry in the messages array has the following attributes:
  #
  #     Name   Type     Description
  #     id     Integer  The message's id.
  #     level  String   The message's level.
  #     key    String   The message's key.
  #     code   String   The message's code.
  #     args   Json     The message's args.
  #
  # ## Actions
  #
  # **For Request**
  #
  # This will return a list of messages created by `travis-yml` for a request, if any exist.
  #
  # GET <code>/repo/{repository.id}/request/{request.id}/messages</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     request.id         Integer  Value uniquely identifying the request.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #     limit            Integer   How many messages to include in the response. Used for pagination.
  #     offset           Integer   How many messages to skip before the first entry in the response. Used for pagination.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.messages(147_731_561)
  # ```
  #
  # GET <code>/repo/{repository.slug}/request/{request.id}/messages</code>
  #
  #     Template Variable  Type     Description
  #     repository.slug    String   Same as {repository.owner.name}/{repository.name}.
  #     request.id         Integer  Value uniquely identifying the request.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #     limit            Integer   How many messages to include in the response. Used for pagination.
  #     offset           Integer   How many messages to skip before the first entry in the response. Used for pagination.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.messages(147_731_561)
  # ```
  #
  # @param request_id [String, Integer] the request id
  # @return [Success, RequestError]
  def messages(request_id)
    validate_number request_id

    get("#{with_repo}/request/#{request_id}/messages")
  end

  # An individual organization.
  #
  # ## Attributes
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #     Name   Type     Description
  #     id     Integer  Value uniquely identifying the organization.
  #     login  String   Login set on GitHub.
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is {https://developer.travis-ci.com/eager-loading eager loaded}.
  #
  #     Name             Type     Description
  #     id               Integer  Value uniquely identifying the organization.
  #     login            String   Login set on GitHub.
  #     name             String   Name set on GitHub.
  #     github_id        Integer  Id set on GitHub.
  #     avatar_url       String   Avatar_url set on GitHub.
  #     education        Boolean  Whether or not the organization has an education account.
  #     allow_migration  Unknown  The organization's allow_migration.
  #
  # **Additional Attributes**
  #
  #     Name          Type          Description
  #     repositories  [Repository]  Repositories belonging to this organization.
  #     installation  Installation  Installation belonging to the organization.
  #
  # ## Actions
  #
  # **Find**
  #
  # This returns an individual organization.
  #
  # GET <code>/org/{organization.id}</code>
  #
  #     Template Variable  Type      Description
  #     organization.id    Integer   Value uniquely identifying the organization.
  #     Query Parameter    Type      Description
  #     include            [String]  List of attributes to eager load.
  #
  #     Example: GET /org/87
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.organization(87)
  # ```
  #
  # @param org_id [String, Integer] the organization id
  # @raise [TypeError] if given organization id is not a number
  # @return [Success, RequestError]
  def organization(org_id)
    validate_number org_id

    get("#{without_repo}/org/#{org_id}")
  end

  # A list of organizations for the current user.
  #
  # ## Attributes
  #
  #     Name           Type            Description
  #     organizations  [Organization]  List of organizations.
  #
  # **Collection Items**
  #
  # Each entry in the **organizations** array has the following attributes:
  #
  #     Name             Type          Description
  #     id               Integer       Value uniquely identifying the organization.
  #     login            String        Login set on GitHub.
  #     name             String        Name set on GitHub.
  #     github_id        Integer       Id set on GitHub.
  #     avatar_url       String        Avatar_url set on GitHub.
  #     education        Boolean       Whether or not the organization has an education account.
  #     allow_migration  Unknown       The organization's allow_migration.
  #     repositories     [Repository]  Repositories belonging to this organization.
  #     installation     Installation  Installation belonging to the organization.
  #
  # ## Actions
  #
  # **For Current User**
  #
  # This returns a list of organizations the current user is a member of.
  #
  # GET <code>/orgs</code>
  #
  #     Query Parameter    Type      Description
  #     include            [String]  List of attributes to eager load.
  #     limit              Integer   How many organizations to include in the response. Used for pagination.
  #     offset             Integer   How many organizations to skip before the first entry in the response. Used for pagination.
  #     organization.role  Unknown   Documentation missing.
  #     role               Unknown   Alias for organization.role.
  #     sort_by            [String]  Attributes to sort organizations by. Used for pagination.
  #
  #     Example: GET /orgs?limit=5
  #
  # **Sortable by:** <code>id</code>, <code>login</code>, <code>name</code>, <code>github_id</code>, append <code>:desc</code> to any attribute to reverse order.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.options.build({limit: 5})
  # travis.organizations
  # ```
  #
  # @return [Success, RequestError]
  def organizations
    get("#{without_repo}/orgs#{opts}")
  end

  # This will be either a {https://developer.travis-ci.com/resource/user user} or {https://developer.travis-ci.com/resource/organization organization}.
  #
  # ## Attributes
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #     Name    Type     Description
  #     id      Integer  Value uniquely identifying the owner.
  #     login   String   User or organization login set on GitHub.
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is {https://developer.travis-ci.com/eager-loading eager loaded}.
  #
  #     Name        Type     Description
  #     id          Integer  Value uniquely identifying the owner.
  #     login       String   User or organization login set on GitHub.
  #     name        String   User or organization name set on GitHub.
  #     github_id   Integer  User or organization id set on GitHub.
  #     avatar_url  String   Link to user or organization avatar (image) set on GitHub.
  #
  # **Additional Attributes**
  #
  #     Name           Type           Description
  #     repositories   [Repository]   Repositories belonging to this account.
  #
  # ## Actions
  #
  # **Find**
  #
  # This returns an individual owner. It is possible to use the GitHub login or github_id in the request.
  #
  # GET <code>/owner/{owner.login}</code>
  #
  #     Template Variable  Type      Description
  #     owner.login        String    User or organization login set on GitHub.
  #
  #     Query Parameter    Type      Description
  #     include            [String]  List of attributes to eager load.
  #
  #     Example: GET /owner/danielpclark
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.owner
  # # or
  # travis.owner('danielpclark')
  # ```
  #
  # GET <code>/owner/{user.login}</code>
  #
  #     Template Variable  Type      Description
  #     user.login         String    Login set on GitHub.
  #
  #     Query Parameter    Type      Description
  #     include            [String]  List of attributes to eager load.
  #
  #     Example: GET /owner/danielpclark
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.owner
  # # or
  # travis.owner('danielpclark')
  # ```
  #
  # GET <code>/owner/{organization.login}</code>
  #
  #     Template Variable   Type      Description
  #     organization.login  String    Login set on GitHub.
  #
  #     Query Parameter     Type      Description
  #     include             [String]  List of attributes to eager load.
  #
  #     Example: GET /owner/travis-ci
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.owner('travis-ci')
  # ```
  #
  # GET <code>/owner/github_id/{owner.github_id}</code>
  #
  #     Template Variable   Type      Description
  #     owner.github_id     Integer   User or organization id set on GitHub.
  #
  #     Query Parameter     Type      Description
  #     include             [String]  List of attributes to eager load.
  #
  #     Example: GET /owner/github_id/639823
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.owner(639_823)
  # ```
  #
  # @param owner [String] username or github id
  # @return [Success, RequestError]
  def owner(owner = username)
    number?(owner) and return get("#{without_repo}/owner/github_id/#{owner}")
    get("#{without_repo}/owner/#{owner}")
  end

  # Individual preferences for current user or organization.
  #
  # ## Attributes
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is {https://developer.travis-ci.com/eager-loading eager loaded}.
  #
  #     Name   Type     Description
  #     name   Unknown  The preference's name.
  #     value  Unknown  The preference's value.
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #     Name   Type     Description
  #     name   Unknown  The preference's name.
  #     value  Unknown  The preference's value.
  #
  # ## Actions
  #
  # **For Organization**
  #
  # Get preference for organization.
  #
  # GET <code>/org/{organization.id}/preference/{preference.name}</code>
  #
  #     Template Variable  Type     Description
  #     organization.id    Integer  Value uniquely identifying the organization.
  #     preference.name    Unknown  The preference's name.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.preference('private_insights_visibility', org_id: 107_660)
  # ```
  #
  # **Update**
  #
  # Set preference for organization.
  #
  # PATCH <code>/org/{organization.id}/preference/{preference.name}</code>
  #
  #     Template Variable  Type     Description
  #     organization.id    Integer  Value uniquely identifying the organization.
  #     preference.name    Unknown  The preference's name.
  #     Accepted Parameter  Type     Description
  #     preference.value    Unknown  The preference's value.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.preference('private_insights_visibility', 'admins', org_id: 107_660)
  # ```
  #
  # Set preference for current user.
  #
  # PATCH <code>/preference/{preference.name}</code>
  #
  #     Template Variable  Type     Description
  #     preference.name    Unknown  The preference's name.
  #     Accepted Parameter  Type     Description
  #     preference.value    Unknown  The preference's value.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.preference('build_emails', true)
  # ```
  #
  # **Find**
  #
  # Get preference for current user.
  #
  # GET <code>/preference/{preference.name}</code>
  #
  #     Template Variable  Type     Description
  #     preference.name    Unknown  The preference's name.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.preference('build_emails')
  # ```
  #
  # @note requests require an authorization token set in the headers. See: {authorization=}
  #
  # @param key [String] preference name to get or set
  # @param value [String] optional value to set preference
  # @param org_id [String, Integer] optional keyword argument for an organization id
  # @return [Success, RequestError]
  def preference(key, value = nil, org_id: nil)
    if org_id
      validate_number org_id
      org_id = "/org/#{org_id}"
    end

    value and return patch("#{without_repo}#{org_id}/preference/#{key}", 'preference.value' => value)
    get("#{without_repo}#{org_id}/preference/#{key}")
  end

  # Preferences for current user or organization.
  #
  # ## Attributes
  #
  #     Name         Type         Description
  #     preferences  [Preferenc]  List of preferences.
  #
  # ## Actions
  #
  # **For Organization**
  #
  # Gets preferences for organization.
  #
  # GET <code>/org/{organization.id}/preferences</code>
  #
  #     Template Variable  Type     Description
  #     organization.id    Integer  Value uniquely identifying the organization.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /org/87/preferences
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.preferences(107_660)
  # ```
  #
  # **For User**
  #
  # Gets preferences for current user.
  #
  # GET <code>/preferences</code>
  #
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /preferences
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.preferences
  # ```
  #
  # @note requests require an authorization token set in the headers. See: {authorization=}
  #
  # @param org_id [String, Integer] optional organization id
  # @return [Success, RequestError]
  def preferences(org_id = nil)
    if org_id
      validate_number org_id
      org_id = "/org/#{org_id}"
    end

    get("#{without_repo}#{org_id}/preferences")
  end

  # A list of repositories for the current user.
  #
  # ## Attributes
  #
  #     Name           Type           Description
  #     repositories   [Repository]   List of repositories.
  #
  # **Collection Items**
  #
  # Each entry in the repositories array has the following attributes:
  #
  #     Name                Type     Description
  #     id                  Integer  Value uniquely identifying the repository.
  #     name                String   The repository's name on GitHub.
  #     slug                String   Same as {repository.owner.name}/{repository.name}.
  #     description         String   The repository's description from GitHub.
  #     github_language     String   The main programming language used according to GitHub.
  #     active              Boolean  Whether or not this repository is currently enabled on Travis CI.
  #     private             Boolean  Whether or not this repository is private.
  #     owner               Owner    GitHub user or organization the repository belongs to.
  #     default_branch      Branch   The default branch on GitHub.
  #     starred             Boolean  Whether or not this repository is starred.
  #     current_build       Build    The most recently started build (this excludes builds that have been created but have not yet started).
  #     last_started_build  Build    Alias for current_build.
  #
  # ## Actions
  #
  # **For Owner**
  #
  # This returns a list of repositories an owner has access to.
  #
  # GET <code>/owner/{owner.login}/repos</code>
  #
  #     Template Variable  Type    Description
  #     owner.login        String  User or organization login set on GitHub.
  #
  #     Query Parameter     Type       Description
  #     active              [Boolean]  Alias for repository.active.
  #     include             [String]   List of attributes to eager load.
  #     limit               Integer    How many repositories to include in the response. Used for pagination.
  #     offset              Integer    How many repositories to skip before the first entry in the response. Used for pagination.
  #     private             [Boolean]  Alias for repository.private.
  #     repository.active   [Boolean]  Filters repositories by whether or not this repository is currently enabled on Travis CI.
  #     repository.private  [Boolean]  Filters repositories by whether or not this repository is private.
  #     repository.starred  [Boolean]  Filters repositories by whether or not this repository is starred.
  #     sort_by             [String]   Attributes to sort repositories by. Used for pagination.
  #     starred             [Boolean]  Alias for repository.starred.
  #
  #     Example: GET /owner/danielpclark/repos?limit=5&sort_by=active,name
  #
  # **Sortable by:** <code>id</code>, <code>github_id</code>, <code>owner_name</code>, <code>name</code>, <code>active</code>, <code>default_branch.last_build</code>, append <code>:desc</code> to any attribute to reverse order.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.options.build({limit: 5, sort_by: 'active,name'})
  # travis.repositories
  # # or
  # travis.repositories('danielpclark')
  # ```
  #
  # GET <code>/owner/{user.login}/repos</code>
  #
  #     Template Variable  Type    Description
  #     user.login         String  Login set on GitHub.
  #
  #     Query Parameter     Type       Description
  #     active              [Boolean]  Alias for repository.active.
  #     include             [String]   List of attributes to eager load.
  #     limit               Integer    How many repositories to include in the response. Used for pagination.
  #     offset              Integer    How many repositories to skip before the first entry in the response. Used for pagination.
  #     private             [Boolean]  Alias for repository.private.
  #     repository.active   [Boolean]  Filters repositories by whether or not this repository is currently enabled on Travis CI.
  #     repository.private  [Boolean]  Filters repositories by whether or not this repository is private.
  #     repository.starred  [Boolean]  Filters repositories by whether or not this repository is starred.
  #     sort_by             [String]   Attributes to sort repositories by. Used for pagination.
  #     starred             [Boolean]  Alias for repository.starred.
  #
  #     Example: GET /owner/danielpclark/repos?limit=5&sort_by=active,name
  #
  # **Sortable by:** <code>id</code>, <code>github_id</code>, <code>owner_name</code>, <code>name</code>, <code>active</code>, <code>default_branch.last_build</code>, append <code>:desc</code> to any attribute to reverse order.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.options.build({limit: 5, sort_by: 'active,name'})
  # travis.repositories
  # # or
  # travis.repositories('danielpclark')
  # ```
  #
  # GET <code>/owner/{organization.login}/repos</code>
  #
  #     Template Variable   Type    Description
  #     organization.login  String  Login set on GitHub.
  #
  #     Query Parameter     Type       Description
  #     active              [Boolean]  Alias for repository.active.
  #     include             [String]   List of attributes to eager load.
  #     limit               Integer    How many repositories to include in the response. Used for pagination.
  #     offset              Integer    How many repositories to skip before the first entry in the response. Used for pagination.
  #     private             [Boolean]  Alias for repository.private.
  #     repository.active   [Boolean]  Filters repositories by whether or not this repository is currently enabled on Travis CI.
  #     repository.private  [Boolean]  Filters repositories by whether or not this repository is private.
  #     repository.starred  [Boolean]  Filters repositories by whether or not this repository is starred.
  #     sort_by             [String]   Attributes to sort repositories by. Used for pagination.
  #     starred             [Boolean]  Alias for repository.starred.
  #
  #     Example: GET /owner/travis-ci/repos?limit=5&sort_by=active,name
  #
  # **Sortable by:** <code>id</code>, <code>github_id</code>, <code>owner_name</code>, <code>name</code>, <code>active</code>, <code>default_branch.last_build</code>, append <code>:desc</code> to any attribute to reverse order.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.options.build({limit: 5, sort_by: 'active,name'})
  # travis.repositories('travis-ci')
  # ```
  #
  # GET <code>/owner/github_id/{owner.github_id}/repos</code>
  #
  #     Template Variable  Type     Description
  #     owner.github_id    Integer  User or organization id set on GitHub.
  #
  #     Query Parameter     Type       Description
  #     active              [Boolean]  Alias for repository.active.
  #     include             [String]   List of attributes to eager load.
  #     limit               Integer    How many repositories to include in the response. Used for pagination.
  #     offset              Integer    How many repositories to skip before the first entry in the response. Used for pagination.
  #     private             [Boolean]  Alias for repository.private.
  #     repository.active   [Boolean]  Filters repositories by whether or not this repository is currently enabled on Travis CI.
  #     repository.private  [Boolean]  Filters repositories by whether or not this repository is private.
  #     repository.starred  [Boolean]  Filters repositories by whether or not this repository is starred.
  #     sort_by             [String]   Attributes to sort repositories by. Used for pagination.
  #     starred             [Boolean]  Alias for repository.starred.
  #
  #     Example: GET /owner/github_id/639823/repos?limit=5&sort_by=active,name
  #
  # **Sortable by:** <code>id</code>, <code>github_id</code>, <code>owner_name</code>, <code>name</code>, <code>active</code>, <code>default_branch.last_build</code>, append <code>:desc</code> to any attribute to reverse order.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.options.build({limit: 5, sort_by: 'active,name'})
  # travis.repositories(639_823)
  # ```
  #
  # **For Current User**
  #
  # This returns a list of repositories the current user has access to.
  #
  # GET <code>/repos</code>
  #
  #     Query Parameter     Type       Description
  #     active              [Boolean]  Alias for repository.active.
  #     include             [String]   List of attributes to eager load.
  #     limit               Integer    How many repositories to include in the response. Used for pagination.
  #     offset              Integer    How many repositories to skip before the first entry in the response. Used for pagination.
  #     private             [Boolean]  Alias for repository.private.
  #     repository.active   [Boolean]  Filters repositories by whether or not this repository is currently enabled on Travis CI.
  #     repository.private  [Boolean]  Filters repositories by whether or not this repository is private.
  #     repository.starred  [Boolean]  Filters repositories by whether or not this repository is starred.
  #     sort_by             [String]   Attributes to sort repositories by. Used for pagination.
  #     starred             [Boolean]  Alias for repository.starred.
  #
  #     Example: GET /repos?limit=5&sort_by=active,name
  #
  # **Sortable by:** <code>id</code>, <code>github_id</code>, <code>owner_name</code>, <code>name</code>, <code>active</code>, <code>default_branch.last_build</code>, append <code>:desc</code> to any attribute to reverse order.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.options.build({limit: 5, sort_by: 'active,name'})
  # travis.repositories(:self)
  # ```
  #
  # @param owner [String, Integer, Symbol] username, github id, or `:self`
  # @return [Success, RequestError]
  def repositories(owner = username)
    owner.equal?(:self) and return get("#{without_repo}/repos#{opts}")
    number?(owner) and return get("#{without_repo}/owner/github_id/#{owner}/repos#{opts}")
    get("#{without_repo}/owner/#{owner}/repos#{opts}")
  end

  # An individual repository.
  #
  # ## Attributes
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #     Name   Type     Description
  #     id     Integer  Value uniquely identifying the repository.
  #     name   String   The repository's name on GitHub.
  #     slug   String   Same as {repository.owner.name}/{repository.name}.
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is eager loaded.
  #
  #     Name             Type     Description
  #     id               Integer  Value uniquely identifying the repository.
  #     name             String   The repository's name on GitHub.
  #     slug             String   Same as {repository.owner.name}/{repository.name}.
  #     description      String   The repository's description from GitHub.
  #     github_language  String   The main programming language used according to GitHub.
  #     active           Boolean  Whether or not this repository is currently enabled on Travis CI.
  #     private          Boolean  Whether or not this repository is private.
  #     owner            Owner    GitHub user or organization the repository belongs to.
  #     default_branch   Branch   The default branch on GitHub.
  #     starred          Boolean  Whether or not this repository is starred.
  #
  # ## Actions
  #
  # **Find**
  #
  # This returns an individual repository.
  #
  # GET <code>/repo/{repository.id}</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /repo/891
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.repository('danielpclark/trav3')
  # ```
  #
  # GET <code>/repo/{repository.slug}</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /repo/rails%2Frails
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.repository('danielpclark/trav3')
  # ```
  #
  # **Activate**
  #
  # This will activate a repository, allowing its tests to be run on Travis CI.
  #
  # POST <code>/repo/{repository.id}/activate</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #
  #     Example: POST /repo/891/activate
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.repository('danielpclark/trav3', :activate)
  # ```
  #
  # POST <code>/repo/{repository.slug}/activate</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #
  #     Example: POST /repo/rails%2Frails/activate
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.repository('danielpclark/trav3', :activate)
  # ```
  #
  # **Deactivate**
  #
  # This will deactivate a repository, preventing any tests from running on Travis CI.
  #
  # POST <code>/repo/{repository.id}/deactivate</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #
  #     Example: POST /repo/891/deactivate
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.repository('danielpclark/trav3', :deactivate)
  # ```
  #
  # POST <code>/repo/{repository.slug}/deactivate</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #
  #     Example: POST /repo/rails%2Frails/deactivate
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.repository('danielpclark/trav3', :deactivate)
  # ```
  #
  # **Star**
  #
  # This will star a repository based on the currently logged in user.
  #
  # POST <code>/repo/{repository.id}/star</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #
  #     Example: POST /repo/891/star
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.repository('danielpclark/trav3', :star)
  # ```
  #
  # POST <code>/repo/{repository.slug}/star</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #
  #     Example: POST /repo/rails%2Frails/star
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.repository('danielpclark/trav3', :star)
  # ```
  #
  # **Unstar**
  #
  # This will unstar a repository based on the currently logged in user.
  #
  # POST <code>/repo/{repository.id}/unstar</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #
  #     Example: POST /repo/891/unstar
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.repository('danielpclark/trav3', :unstar)
  # ```
  #
  # POST <code>/repo/{repository.slug}/unstar</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #
  #     Example: POST /repo/rails%2Frails/unstar
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.repository('danielpclark/trav3', :unstar)
  # ```
  #
  # @note POST requests require an authorization token set in the headers. See: {authorization=}
  #
  # @param repo [String] github_username/repository_name
  # @param action [String, Symbol] Optional argument for star/unstar/activate/deactivate
  # @raise [InvalidRepository] if given input does not
  #   conform to valid repository identifier format
  # @return [Success, RequestError]
  def repository(repo = repository_name, action = nil)
    validate_repo_format repo

    repo = sanitize_repo_name repo

    action and return post("#{without_repo}/repo/#{repo}/#{action}")
    get("#{without_repo}/repo/#{repo}")
  end

  # An individual request
  #
  # ## Attributes
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #     Name     Type     Description
  #     id       Integer  Value uniquely identifying the request.
  #     state    String   The state of a request (eg. whether it has been processed or not).
  #     result   String   The result of the request (eg. rejected or approved).
  #     message  String   Travis-ci status message attached to the request.
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is {https://developer.travis-ci.com/eager-loading eager loaded}.
  #
  #     Name         Type        Description
  #     id           Integer     Value uniquely identifying the request.
  #     state        String      The state of a request (eg. whether it has been processed or not).
  #     result       String      The result of the request (eg. rejected or approved).
  #     message      String      Travis-ci status message attached to the request.
  #     repository   Repository  GitHub user or organization the request belongs to.
  #     branch_name  String      Name of the branch requested to be built.
  #     commit       Commit      The commit the request is associated with.
  #     builds       [Build]     The request's builds.
  #     owner        Owner       GitHub user or organization the request belongs to.
  #     created_at   String      When Travis CI created the request.
  #     event_type   String      Origin of request (push, pull request, api).
  #     base_commit  String      The base commit the request is associated with.
  #     head_commit  String      The head commit the request is associated with.
  #
  # ## Actions
  #
  # **Find**
  #
  # Get the request by id for the current repository
  #
  # GET <code>/repo/{repository.id}/request/{request.id}</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     request.id         Integer  Value uniquely identifying the request.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.request(147_776_757)
  # ```
  #
  # GET <code>/repo/{repository.slug}/request/{request.id}</code>
  #
  #     Template Variable  Type     Description
  #     repository.slug    String   Same as {repository.owner.name}/{repository.name}.
  #     request.id         Integer  Value uniquely identifying the request.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.request(147_776_757)
  # ```
  #
  # @param request_id [String, Integer] request id
  # @return [Success, RequestError]
  def request(request_id)
    validate_number request_id

    get("#{with_repo}/request/#{request_id}")
  end

  # A list of requests.
  #
  # If querying using the repository slug, it must be formatted using {http://www.w3schools.com/tags/ref_urlencode.asp standard URL encoding}, including any special characters.
  #
  # ## Attributes
  #
  #     Name      Type       Description
  #     requests  [Request]  List of requests.
  #
  # **Collection Items**
  #
  # Each entry in the **requests** array has the following attributes:
  #
  #     Name         Type        Description
  #     id           Integer     Value uniquely identifying the request.
  #     state        String      The state of a request (eg. whether it has been processed or not).
  #     result       String      The result of the request (eg. rejected or approved).
  #     message      String      Travis-ci status message attached to the request.
  #     repository   Repository  GitHub user or organization the request belongs to.
  #     branch_name  String      Name of the branch requested to be built.
  #     commit       Commit      The commit the request is associated with.
  #     builds       [Build]     The request's builds.
  #     owner        Owner       GitHub user or organization the request belongs to.
  #     created_at   String      When Travis CI created the request.
  #     event_type   String      Origin of request (push, pull request, api).
  #     base_commit  String      The base commit the request is associated with.
  #     head_commit  String      The head commit the request is associated with.
  #     yaml_config  Unknown     The request's yaml_config.
  #
  # ## Actions
  #
  # **Find**
  #
  # This will return a list of requests belonging to a repository.
  #
  # GET <code>/repo/{repository.id}/requests</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #     limit            Integer   How many requests to include in the response. Used for pagination.
  #     offset           Integer   How many requests to skip before the first entry in the response. Used for pagination.
  #
  #     Example: GET /repo/891/requests?limit=5
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.options.build({limit: 5})
  # travis.requests
  # ```
  #
  # GET <code>/repo/{repository.slug}/requests</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #     limit            Integer   How many requests to include in the response. Used for pagination.
  #     offset           Integer   How many requests to skip before the first entry in the response. Used for pagination.
  #
  #     Example: GET /repo/rails%2Frails/requests?limit=5
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.options.build({limit: 5})
  # travis.requests
  # ```
  #
  # **Create**
  #
  # This will create a request for an individual repository, triggering a build to run on Travis CI.
  #
  # Use namespaced params in JSON format in the request body to pass any accepted parameters. Any keys in the request's config will override keys existing in the `.travis.yml`.
  #
  # ```bash
  # curl -X POST \
  #   -H "Content-Type: application/json" \
  #   -H "Travis-API-Version: 3" \
  #   -H "Authorization: token xxxxxxxxxxxx" \
  #   -d '{ "request": {
  #         "message": "Override the commit message: this is an api request", "branch": "master" }}'\
  #   https://api.travis-ci.com/repo/1/requests
  # ```
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.requests(
  #   message: 'Override the commit message: this is an api request',
  #   branch: 'master'
  # )
  # ```
  #
  # The response includes the following body:
  #
  # ```json
  # {
  #   "@type":              "pending",
  #   "remaining_requests": 1,
  #   "repository":         {
  #     "@type":            "repository",
  #     "@href":            "/repo/1",
  #     "@representation":  "minimal",
  #     "id":               1,
  #     "name":             "test",
  #     "slug":             "owner/repo"
  #   },
  #   "request":            {
  #     "repository":       {
  #       "id":             1,
  #       "owner_name":     "owner",
  #       "name":           "repo"
  #     },
  #     "user":             {
  #       "id":             1
  #     },
  #     "id":               1,
  #     "message":          "Override the commit message: this is an api request",
  #     "branch":           "master",
  #     "config":           { }
  #   },
  #   "resource_type":      "request"
  # }
  # ```
  #
  # POST <code>/repo/{repository.id}/requests</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     Accepted Parameter  Type    Description
  #     request.config      String  Build configuration (as parsed from .travis.yml).
  #     request.message     String  Travis-ci status message attached to the request.
  #     request.branch      String  Branch requested to be built.
  #     request.token       Object  Travis token associated with webhook on GitHub (DEPRECATED).
  #
  #     Example: POST /repo/891/requests
  #
  # POST <code>/repo/{repository.slug}/requests</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     Accepted Parameter  Type    Description
  #     request.config      String  Build configuration (as parsed from .travis.yml).
  #     request.message     String  Travis-ci status message attached to the request.
  #     request.branch      String  Branch requested to be built.
  #     request.token       Object  Travis token associated with webhook on GitHub (DEPRECATED).
  #
  #     Example: POST /repo/rails%2Frails/requests
  #
  # @param attributes [Hash] request attributes
  # @return [Success, RequestError]
  def requests(**attributes)
    return get("#{with_repo}/requests") if attributes.empty?

    create("#{with_repo}/requests", 'request': attributes)
  end

  # A list of stages.
  #
  # Currently this is nested within a build.
  #
  # ## Attributes
  #
  #     Name    Type     Description
  #     stages  [Stage]  List of stages.
  #
  # **Collection Items**
  #
  # Each entry in the stages array has the following attributes:
  #
  #     Name         Type     Description
  #     id           Integer  Value uniquely identifying the stage.
  #     number       Integer  Incremental number for a stage.
  #     name         String   The name of the stage.
  #     state        String   Current state of the stage.
  #     started_at   String   When the stage started.
  #     finished_at  String   When the stage finished.
  #     jobs         [Job]    The jobs of a stage.
  #
  # ## Actions
  #
  # **Find**
  #
  # This returns a list of stages belonging to an individual build.
  #
  # GET <code>/build/{build.id}/stages</code>
  #
  #     Template Variable  Type     Description
  #     build.id           Integer  Value uniquely identifying the build.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /build/86601346/stages
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.stages(479_113_572)
  # ```
  #
  # @param build_id [String, Integer] build id
  # @raise [TypeError] if given build id is not a number
  # @return [Success, RequestError]
  def stages(build_id)
    validate_number build_id

    get("#{without_repo}/build/#{build_id}/stages")
  end

  # An individual repository setting. These are settings on a repository that can be adjusted by the user. There are currently five different kinds of settings a user can modify:
  #
  # * `builds_only_with_travis_yml` (boolean)
  # * `build_pushes` (boolean)
  # * `build_pull_requests` (boolean)
  # * `maximum_number_of_builds` (integer)
  # * `auto_cancel_pushes` (boolean)
  # * `auto_cancel_pull_requests` (boolean)
  #
  # If querying using the repository slug, it must be formatted using {http://www.w3schools.com/tags/ref_urlencode.asp standard URL encoding}, including any special characters.
  #
  # ## Attributes
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is {https://developer.travis-ci.com/eager-loading eager loaded}.
  #
  #     Name   Type                Description
  #     name   String              The setting's name.
  #     value  Boolean or integer  The setting's value.
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #   Name   Type                Description
  #   name   String              The setting's name.
  #   value  Boolean or integer  The setting's value.
  #
  # ## Actions
  #
  # **Find**
  #
  # This returns a single setting. It is possible to use the repository id or slug in the request.
  #
  # GET <code>/repo/{repository.id}/setting/{setting.name}</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     setting.name       String   The setting's name.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.setting('auto_cancel_pull_requests')
  # ```
  #
  # GET <code>/repo/{repository.slug}/setting/{setting.name}</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     setting.name       String  The setting's name.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.setting('auto_cancel_pull_requests')
  # ```
  #
  # **Update**
  #
  # This updates a single setting. It is possible to use the repository id or slug in the request.
  #
  # Use namespaced params in the request body to pass the new setting:
  #
  # ```bash
  # curl -X PATCH \
  #   -H "Content-Type: application/json" \
  #   -H "Travis-API-Version: 3" \
  #   -H "Authorization: token xxxxxxxxxxxx" \
  #   -d '{ "setting.value": true }' \
  #   https://api.travis-ci.com/repo/1234/setting/{setting.name}
  # ```
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.setting('auto_cancel_pull_requests', false)
  # ```
  #
  # PATCH <code>/repo/{repository.id}/setting/{setting.name}</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     setting.name       String   The setting's name.
  #     Accepted Parameter  Type                Description
  #     setting.value       Boolean or integer  The setting's value.
  #
  # PATCH <code>/repo/{repository.slug}/setting/{setting.name}</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     setting.name       String  The setting's name.
  #     Accepted Parameter  Type                Description
  #     setting.value       Boolean or integer  The setting's value.
  #
  # @param name [String] the setting name for the current repository
  # @param value [String] optional argument for setting a value for the setting name
  # @return [Success, RequestError]
  def setting(name, value = nil)
    return get("#{with_repo}/setting/#{name}") if value.nil?

    patch("#{with_repo}/setting/#{name}", 'setting.value' => value)
  end

  # A list of user settings. These are settings on a repository that can be adjusted by the user. There are currently six different kinds of user settings:
  #
  # * `builds_only_with_travis_yml` (boolean)
  # * `build_pushes` (boolean)
  # * `build_pull_requests` (boolean)
  # * `maximum_number_of_builds` (integer)
  # * `auto_cancel_pushes` (boolean)
  # * `auto_cancel_pull_requests` (boolean)
  #
  # If querying using the repository slug, it must be formatted using {http://www.w3schools.com/tags/ref_urlencode.asp standard URL encoding}, including any special characters.
  #
  # ## Attributes
  #
  #     Name      Type       Description
  #     settings  [Setting]  List of settings.
  #
  # **Collection Items**
  #
  # Each entry in the settings array has the following attributes:
  #
  #     Name   Type                Description
  #     name   String              The setting's name.
  #     value  Boolean or integer  The setting's value.
  #
  # ## Actions
  #
  # **For Repository**
  #
  # This returns a list of the settings for that repository. It is possible to use the repository id or slug in the request.
  #
  # GET <code>/repo/{repository.id}/settings</code>
  #
  #     Template Variable  Type     Description
  #     repository.id      Integer  Value uniquely identifying the repository.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /repo/891/settings
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.settings
  # ```
  #
  # GET <code>/repo/{repository.slug}/settings</code>
  #
  #     Template Variable  Type    Description
  #     repository.slug    String  Same as {repository.owner.name}/{repository.name}.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /repo/rails%2Frails/settings
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.settings
  # ```
  #
  # @return [Success, RequestError]
  def settings
    get("#{with_repo}/settings")
  end

  # An individual user.
  #
  # ## Attributes
  #
  # **Minimal Representation**
  #
  # Included when the resource is returned as part of another resource.
  #
  #     Name  Type     Description
  #     id    Integer  Value uniquely identifying the user.
  #     login String   Login set on GitHub.
  #
  # **Standard Representation**
  #
  # Included when the resource is the main response of a request, or is {https://developer.travis-ci.com/eager-loading eager loaded}.
  #
  #     Name              Type     Description
  #     id                Integer  Value uniquely identifying the user.
  #     login             String   Login set on GitHub.
  #     name              String   Name set on GitHub.
  #     github_id         Integer  Id set on GitHub.
  #     avatar_url        String   Avatar URL set on GitHub.
  #     education         Boolean  Whether or not the user has an education account.
  #     allow_migration   Unknown  The user's allow_migration.
  #     is_syncing        Boolean  Whether or not the user is currently being synced with GitHub.
  #     synced_at         String   The last time the user was synced with GitHub.
  #
  # **Additional Attributes**
  #
  #     Name          Type          Description
  #     repositories  [Repository]  Repositories belonging to this user.
  #     installation  Installation  Installation belonging to the user.
  #     emails        Unknown       The user's emails.
  #
  # ## Actions
  #
  # **Find**
  #
  # This will return information about an individual user.
  #
  # GET <code>/user/{user.id}</code>
  #
  #     Template Variable  Type     Description
  #     user.id            Integer  Value uniquely identifying the user.
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /user/119240
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.user(119_240)
  # ```
  #
  # **Sync**
  #
  # This triggers a sync on a user's account with their GitHub account.
  #
  # POST <code>/user/{user.id}/sync</code>
  #
  #     Template Variable  Type     Description
  #     user.id            Integer  Value uniquely identifying the user.
  #
  #     Example: POST /user/119240/sync
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.user(114_816, :sync)
  # ```
  #
  # **Current**
  #
  # This will return information about the current user.
  #
  # GET <code>/user</code>
  #
  #     Query Parameter  Type      Description
  #     include          [String]  List of attributes to eager load.
  #
  #     Example: GET /user
  #
  # ```ruby
  # # RUBY EXAMPLE
  # travis = Trav3::Travis.new('danielpclark/trav3')
  # travis.authorization = 'xxxx'
  # travis.user
  # ```
  #
  # @note sync feature may not be permitted
  # @note POST requests require an authorization token set in the headers. See: {authorization=}
  #
  # @param user_id [String, Integer] optional user id
  # @param sync [Boolean] optional argument for syncing your Travis CI account with GitHub
  # @raise [TypeError] if given user id is not a number
  # @return [Success, RequestError]
  def user(user_id = nil, sync = false)
    return get("#{without_repo}/user") if !user_id && !sync

    validate_number user_id

    sync and return post("#{without_repo}/user/#{user_id}/sync")
    get("#{without_repo}/user/#{user_id}")
  end

  # @!endgroup

  private # @private

  def create(url, data = {})
    Trav3::REST.create(self, url, data)
  end

  def cron_keys(hash)
    inject_property_name('cron', hash)
  end

  def delete(url)
    Trav3::REST.delete(self, url)
  end

  def env_var_keys(hash)
    inject_property_name('env_var', hash)
  end

  def get(url, raw_reply = false)
    Trav3::REST.get(self, url, raw_reply)
  end

  def get_path(url)
    get("#{without_repo}#{url}")
  end

  def get_path_with_opts(url, without_limit = true)
    url, opt = url.match(/^(.+)\?(.*)$/)&.captures || url
    opts.immutable do |o|
      o.remove(:limit) if without_limit
      o.send(:update, opt)
      get_path("#{url}#{opts}")
    end
  end

  def initial_defaults
    defaults(limit: 25)
    h('Content-Type': 'application/json')
    h('Accept': 'application/json')
    h('Travis-API-Version': 3)
  end

  def inject_property_name(name, hash)
    raise TypeError, "Hash expected, #{input.class} given" unless hash.is_a? Hash
    return hash.map { |k, v| ["#{name}.#{k}", v] }.to_h unless hash.keys.first.match?(/^#{name}\.\w+$/)

    hash
  end

  def key_pair_keys(hash)
    inject_property_name('key_pair', hash)
  end

  def number?(input)
    /^\d+$/.match? input.to_s
  end

  def opts
    @options
  end

  def patch(url, data)
    Trav3::REST.patch(self, url, data)
  end

  def post(url, body = nil)
    Trav3::REST.post(self, url, body)
  end

  def validate_api_endpoint(input)
    raise InvalidAPIEndpoint unless /^https:\/\/api\.travis-ci\.(?:org|com)$/.match? input
  end

  def validate_number(input)
    raise TypeError, "Integer expected, #{input.class} given" unless number? input
  end

  def validate_repo_format(input)
    raise InvalidRepository unless repo_slug_or_id? input
  end

  def validate_string(input)
    raise TypeError, "String expected, #{input.class} given" unless input.is_a? String
  end

  def repo_slug_or_id?(input)
    Regexp.new(/(^\d+$)|(^[A-Za-z0-9_.-]+(?:\/|%2F){1}[A-Za-z0-9_.-]+$)/i).match? input
  end

  def repository_name
    @repo
  end

  def sanitize_repo_name(repo)
    repo.to_s.gsub(/\//, '%2F')
  end

  def username
    @repo[/.*?(?=(?:\/|%2F)|$)/]
  end

  def with_repo
    "#{api_endpoint}/repo/#{@repo}"
  end

  def without_repo
    api_endpoint
  end

  def without_limit
    limit = opts.remove(:limit)
    result = yield
    opts.build(limit: limit) if limit
    result
  end
end

Instance Method Details

#active(owner = username) ⇒ Success, RequestError

Please Note that the naming of this endpoint may be changed. Our naming convention for this information is in flux. If you have suggestions for how this information should be presented please leave us feedback by commenting in this issue here or emailing support support@travis-ci.com.

A list of all the builds in an “active” state, either created or started.

Attributes

Name    Type    Description
builds  Builds  The active builds.

Actions

For Owner

Returns a list of “active” builds for the owner.

GET /owner/{owner.login}/active

Template Variable  Type    Description
owner.login        String  User or organization login set on GitHub.
Query Parameter  Type      Description
include          [String]  List of attributes to eager load.

Example: GET /owner/danielpclark/active
# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.active
# or
travis.active('danielpclark')

GET /owner/{user.login}/active

Template Variable  Type    Description
user.login         String  Login set on GitHub.
Query Parameter  Type      Description
include          [String]  List of attributes to eager load.

Example: GET /owner/danielpclark/active
# RUBY EXAMPLE
travis = Trav3::Travis.new('danielpclark/trav3')
travis.active
# or
travis.active('danielpclark')

GET /owner/{organization.login}/active

Template Variable   Type    Description
organization.login  String  Login set on GitHub.
Query Parameter  Type      Description
include          [String]  List of attributes to eager load.

Example: GET /owner/travis-ci/active
# RUBY EXAMPLE
travis = Trav3::Travis.new('dan