diff --git a/docs/data/contributors.json b/docs/data/contributors.json index 888df2f7d..f2dbd5693 100644 --- a/docs/data/contributors.json +++ b/docs/data/contributors.json @@ -1 +1 @@ -{"openapi-typescript":[{"username":"drwpow","name":"Drew Powers","avatar":"https://avatars.githubusercontent.com/u/1369770?v=4","links":[{"icon":"github","link":"https://github.com/drwpow"}],"lastFetch":1734600070672},{"username":"psmyrdek","name":"Przemek Smyrdek","avatar":"https://avatars.githubusercontent.com/u/6187417?v=4","links":[{"icon":"github","link":"https://github.com/psmyrdek"}],"lastFetch":1734600070854},{"username":"enmand","name":"Dan Enman","avatar":"https://avatars.githubusercontent.com/u/432487?v=4","links":[{"icon":"github","link":"https://github.com/enmand"}],"lastFetch":1734600071027},{"username":"atlefren","name":"Atle Frenvik Sveen","avatar":"https://avatars.githubusercontent.com/u/1829927?v=4","links":[{"icon":"github","link":"https://github.com/atlefren"}],"lastFetch":1734600071202},{"username":"tpdewolf","name":"Tim de Wolf","avatar":"https://avatars.githubusercontent.com/u/4455209?v=4","links":[{"icon":"github","link":"https://github.com/tpdewolf"}],"lastFetch":1734600071368},{"username":"tombarton","name":"Tom Barton","avatar":"https://avatars.githubusercontent.com/u/6222711?v=4","links":[{"icon":"github","link":"https://github.com/tombarton"}],"lastFetch":1734600071556},{"username":"svnv","name":"Sven Nicolai Viig","avatar":"https://avatars.githubusercontent.com/u/1080888?v=4","links":[{"icon":"github","link":"https://github.com/svnv"}],"lastFetch":1734600071729},{"username":"sorin-davidoi","name":"Sorin Davidoi","avatar":"https://avatars.githubusercontent.com/u/2109702?v=4","links":[{"icon":"github","link":"https://github.com/sorin-davidoi"}],"lastFetch":1734600071904},{"username":"scvnathan","name":"Nathan Schneirov","avatar":"https://avatars.githubusercontent.com/u/73474?v=4","links":[{"icon":"github","link":"https://github.com/scvnathan"}],"lastFetch":1734600072080},{"username":"lbenie","name":"Lucien Bénié","avatar":"https://avatars.githubusercontent.com/u/7316046?v=4","links":[{"icon":"github","link":"https://github.com/lbenie"}],"lastFetch":1734600072254},{"username":"bokub","name":"Boris","avatar":"https://avatars.githubusercontent.com/u/17952318?v=4","links":[{"icon":"github","link":"https://github.com/bokub"}],"lastFetch":1734600072427},{"username":"antonk52","name":"Anton Kastritskii","avatar":"https://avatars.githubusercontent.com/u/5817809?v=4","links":[{"icon":"github","link":"https://github.com/antonk52"}],"lastFetch":1734600072590},{"username":"tshelburne","name":"Tim Shelburne","avatar":"https://avatars.githubusercontent.com/u/1202267?v=4","links":[{"icon":"github","link":"https://github.com/tshelburne"}],"lastFetch":1734600072769},{"username":"typeofweb","name":"Michał Miszczyszyn","avatar":"https://avatars.githubusercontent.com/u/1338731?v=4","links":[{"icon":"github","link":"https://github.com/typeofweb"}],"lastFetch":1734600072966},{"username":"skh-","name":"Sam K Hall","avatar":"https://avatars.githubusercontent.com/u/1292598?v=4","links":[{"icon":"github","link":"https://github.com/skh-"}],"lastFetch":1734600073150},{"username":"BlooJeans","name":"Matt Jeanes","avatar":"https://avatars.githubusercontent.com/u/1751182?v=4","links":[{"icon":"github","link":"https://github.com/BlooJeans"}],"lastFetch":1734600073307},{"username":"selbekk","name":"Kristofer Giltvedt Selbekk","avatar":"https://avatars.githubusercontent.com/u/1307267?v=4","links":[{"icon":"github","link":"https://github.com/selbekk"}],"lastFetch":1734600073484},{"username":"Mause","name":"Elliana May","avatar":"https://avatars.githubusercontent.com/u/1405026?v=4","links":[{"icon":"github","link":"https://github.com/Mause"}],"lastFetch":1734600073641},{"username":"henhal","name":"Henrik Hall","avatar":"https://avatars.githubusercontent.com/u/9608258?v=4","links":[{"icon":"github","link":"https://github.com/henhal"}],"lastFetch":1734600073859},{"username":"gr2m","name":"Gregor Martynus","avatar":"https://avatars.githubusercontent.com/u/39992?v=4","links":[{"icon":"github","link":"https://github.com/gr2m"}],"lastFetch":1734600074035},{"username":"samdbmg","name":"Sam Mesterton-Gibbons","avatar":"https://avatars.githubusercontent.com/u/408983?v=4","links":[{"icon":"github","link":"https://github.com/samdbmg"}],"lastFetch":1734600074211},{"username":"rendall","name":"Rendall","avatar":"https://avatars.githubusercontent.com/u/293263?v=4","links":[{"icon":"github","link":"https://github.com/rendall"}],"lastFetch":1734600074396},{"username":"robertmassaioli","name":"Robert Massaioli","avatar":"https://avatars.githubusercontent.com/u/149178?v=4","links":[{"icon":"github","link":"https://github.com/robertmassaioli"}],"lastFetch":1734600074580},{"username":"jankuca","name":"Jan Kuča","avatar":"https://avatars.githubusercontent.com/u/367262?v=4","links":[{"icon":"github","link":"https://github.com/jankuca"}],"lastFetch":1734600074748},{"username":"th-m","name":"Thomas Valadez","avatar":"https://avatars.githubusercontent.com/u/13792029?v=4","links":[{"icon":"github","link":"https://github.com/th-m"}],"lastFetch":1734600075008},{"username":"asithade","name":"Asitha de Silva","avatar":"https://avatars.githubusercontent.com/u/3814354?v=4","links":[{"icon":"github","link":"https://github.com/asithade"}],"lastFetch":1734600075177},{"username":"misha-erm","name":"Misha","avatar":"https://avatars.githubusercontent.com/u/8783498?v=4","links":[{"icon":"github","link":"https://github.com/misha-erm"}],"lastFetch":1734600075382},{"username":"radist2s","name":"Alex Batalov","avatar":"https://avatars.githubusercontent.com/u/725645?v=4","links":[{"icon":"github","link":"https://github.com/radist2s"}],"lastFetch":1734600075582},{"username":"FedeBev","name":"Federico Bevione","avatar":"https://avatars.githubusercontent.com/u/22151395?v=4","links":[{"icon":"github","link":"https://github.com/FedeBev"}],"lastFetch":1734600075756},{"username":"yamacent","name":"Daisuke Yamamoto","avatar":"https://avatars.githubusercontent.com/u/8544439?v=4","links":[{"icon":"github","link":"https://github.com/yamacent"}],"lastFetch":1734600075933},{"username":"dnalborczyk","name":null,"avatar":"https://avatars.githubusercontent.com/u/2903325?v=4","links":[{"icon":"github","link":"https://github.com/dnalborczyk"}],"lastFetch":1734600076097},{"username":"FabioWanner","name":null,"avatar":"https://avatars.githubusercontent.com/u/46821078?v=4","links":[{"icon":"github","link":"https://github.com/FabioWanner"}],"lastFetch":1734600076267},{"username":"ashsmith","name":"Ash Smith","avatar":"https://avatars.githubusercontent.com/u/1086841?v=4","links":[{"icon":"github","link":"https://github.com/ashsmith"}],"lastFetch":1734600076462},{"username":"mehalter","name":"Micah Halter","avatar":"https://avatars.githubusercontent.com/u/1591837?v=4","links":[{"icon":"github","link":"https://github.com/mehalter"}],"lastFetch":1734600076646},{"username":"Chrg1001","name":"chrg1001","avatar":"https://avatars.githubusercontent.com/u/40189653?v=4","links":[{"icon":"github","link":"https://github.com/Chrg1001"}],"lastFetch":1734600076838},{"username":"sharmarajdaksh","name":"Dakshraj Sharma","avatar":"https://avatars.githubusercontent.com/u/33689528?v=4","links":[{"icon":"github","link":"https://github.com/sharmarajdaksh"}],"lastFetch":1734600076995},{"username":"shuluster","name":"Shaosu Liu","avatar":"https://avatars.githubusercontent.com/u/1707910?v=4","links":[{"icon":"github","link":"https://github.com/shuluster"}],"lastFetch":1734600077160},{"username":"FDiskas","name":"Vytenis","avatar":"https://avatars.githubusercontent.com/u/468006?v=4","links":[{"icon":"github","link":"https://github.com/FDiskas"}],"lastFetch":1734600077322},{"username":"ericzorn93","name":"Eric Zorn","avatar":"https://avatars.githubusercontent.com/u/22532542?v=4","links":[{"icon":"github","link":"https://github.com/ericzorn93"}],"lastFetch":1734600077512},{"username":"mbelsky","name":"Max Belsky","avatar":"https://avatars.githubusercontent.com/u/3923527?v=4","links":[{"icon":"github","link":"https://github.com/mbelsky"}],"lastFetch":1734600077682},{"username":"techbech","name":"Peter Bech","avatar":"https://avatars.githubusercontent.com/u/1520592?v=4","links":[{"icon":"github","link":"https://github.com/techbech"}],"lastFetch":1734600077855},{"username":"rustyconover","name":"Rusty Conover","avatar":"https://avatars.githubusercontent.com/u/731941?v=4","links":[{"icon":"github","link":"https://github.com/rustyconover"}],"lastFetch":1734600078032},{"username":"bunkscene","name":"Dave Carlson","avatar":"https://avatars.githubusercontent.com/u/2693678?v=4","links":[{"icon":"github","link":"https://github.com/bunkscene"}],"lastFetch":1734600078206},{"username":"ottomated","name":null,"avatar":"https://avatars.githubusercontent.com/u/31470743?v=4","links":[{"icon":"github","link":"https://github.com/ottomated"}],"lastFetch":1734600078401},{"username":"sadfsdfdsa","name":"Artem Shuvaev","avatar":"https://avatars.githubusercontent.com/u/28733669?v=4","links":[{"icon":"github","link":"https://github.com/sadfsdfdsa"}],"lastFetch":1734600078574},{"username":"ajaishankar","name":null,"avatar":"https://avatars.githubusercontent.com/u/328008?v=4","links":[{"icon":"github","link":"https://github.com/ajaishankar"}],"lastFetch":1734600078730},{"username":"dominikdosoudil","name":"Dominik Dosoudil","avatar":"https://avatars.githubusercontent.com/u/15929942?v=4","links":[{"icon":"github","link":"https://github.com/dominikdosoudil"}],"lastFetch":1734600078910},{"username":"kgtkr","name":"kgtkr","avatar":"https://avatars.githubusercontent.com/u/17868838?v=4","links":[{"icon":"github","link":"https://github.com/kgtkr"}],"lastFetch":1734600079118},{"username":"berzi","name":null,"avatar":"https://avatars.githubusercontent.com/u/32619123?v=4","links":[{"icon":"github","link":"https://github.com/berzi"}],"lastFetch":1734600079290},{"username":"PhilipTrauner","name":"philip trauner","avatar":"https://avatars.githubusercontent.com/u/9287847?v=4","links":[{"icon":"github","link":"https://github.com/PhilipTrauner"}],"lastFetch":1734600079441},{"username":"Powell-v2","name":"Pavel Yermolin","avatar":"https://avatars.githubusercontent.com/u/25308326?v=4","links":[{"icon":"github","link":"https://github.com/Powell-v2"}],"lastFetch":1734600079634},{"username":"duncanbeevers","name":"Duncan Beevers","avatar":"https://avatars.githubusercontent.com/u/7367?v=4","links":[{"icon":"github","link":"https://github.com/duncanbeevers"}],"lastFetch":1734600079807},{"username":"tkukushkin","name":"Timofei Kukushkin","avatar":"https://avatars.githubusercontent.com/u/1482516?v=4","links":[{"icon":"github","link":"https://github.com/tkukushkin"}],"lastFetch":1734600080026},{"username":"Semigradsky","name":"Dmitry Semigradsky","avatar":"https://avatars.githubusercontent.com/u/1198848?v=4","links":[{"icon":"github","link":"https://github.com/Semigradsky"}],"lastFetch":1734600080223},{"username":"MrLeebo","name":"Jeremy Liberman","avatar":"https://avatars.githubusercontent.com/u/2754163?v=4","links":[{"icon":"github","link":"https://github.com/MrLeebo"}],"lastFetch":1734600080389},{"username":"axelhzf","name":"Axel Hernández Ferrera","avatar":"https://avatars.githubusercontent.com/u/175627?v=4","links":[{"icon":"github","link":"https://github.com/axelhzf"}],"lastFetch":1734600080552},{"username":"imagoiq","name":"Loïc Fürhoff","avatar":"https://avatars.githubusercontent.com/u/12294151?v=4","links":[{"icon":"github","link":"https://github.com/imagoiq"}],"lastFetch":1734600080731},{"username":"BTMPL","name":"Bartosz Szczeciński","avatar":"https://avatars.githubusercontent.com/u/247153?v=4","links":[{"icon":"github","link":"https://github.com/BTMPL"}],"lastFetch":1734600080902},{"username":"HiiiiD","name":"Marco Salomone","avatar":"https://avatars.githubusercontent.com/u/61231210?v=4","links":[{"icon":"github","link":"https://github.com/HiiiiD"}],"lastFetch":1734600081069},{"username":"yacinehmito","name":"Yacine Hmito","avatar":"https://avatars.githubusercontent.com/u/6893840?v=4","links":[{"icon":"github","link":"https://github.com/yacinehmito"}],"lastFetch":1734600081246},{"username":"sajadtorkamani","name":"Sajad Torkamani","avatar":"https://avatars.githubusercontent.com/u/9380313?v=4","links":[{"icon":"github","link":"https://github.com/sajadtorkamani"}],"lastFetch":1734600081444},{"username":"mvdbeek","name":"Marius van den Beek","avatar":"https://avatars.githubusercontent.com/u/6804901?v=4","links":[{"icon":"github","link":"https://github.com/mvdbeek"}],"lastFetch":1734600081613},{"username":"sgrimm","name":"Steven Grimm","avatar":"https://avatars.githubusercontent.com/u/1248649?v=4","links":[{"icon":"github","link":"https://github.com/sgrimm"}],"lastFetch":1734600081779},{"username":"Swiftwork","name":"Erik Hughes","avatar":"https://avatars.githubusercontent.com/u/455178?v=4","links":[{"icon":"github","link":"https://github.com/Swiftwork"}],"lastFetch":1734600081949},{"username":"mtth","name":"Matthieu Monsch","avatar":"https://avatars.githubusercontent.com/u/1216372?v=4","links":[{"icon":"github","link":"https://github.com/mtth"}],"lastFetch":1734600082114},{"username":"mitchell-merry","name":"Mitchell Merry","avatar":"https://avatars.githubusercontent.com/u/8567231?v=4","links":[{"icon":"github","link":"https://github.com/mitchell-merry"}],"lastFetch":1734600082294},{"username":"qnp","name":"François Risoud","avatar":"https://avatars.githubusercontent.com/u/6012554?v=4","links":[{"icon":"github","link":"https://github.com/qnp"}],"lastFetch":1734600082459},{"username":"shoffmeister","name":null,"avatar":"https://avatars.githubusercontent.com/u/3868036?v=4","links":[{"icon":"github","link":"https://github.com/shoffmeister"}],"lastFetch":1734600082612},{"username":"liangskyli","name":"liangsky","avatar":"https://avatars.githubusercontent.com/u/31531283?v=4","links":[{"icon":"github","link":"https://github.com/liangskyli"}],"lastFetch":1734600082778},{"username":"happycollision","name":"Don Denton","avatar":"https://avatars.githubusercontent.com/u/3663628?v=4","links":[{"icon":"github","link":"https://github.com/happycollision"}],"lastFetch":1734600082973},{"username":"ysmood","name":"Yad Smood","avatar":"https://avatars.githubusercontent.com/u/1415488?v=4","links":[{"icon":"github","link":"https://github.com/ysmood"}],"lastFetch":1734600083134},{"username":"barakalon","name":"barak","avatar":"https://avatars.githubusercontent.com/u/12398927?v=4","links":[{"icon":"github","link":"https://github.com/barakalon"}],"lastFetch":1734600083324},{"username":"horaklukas","name":"Lukáš Horák","avatar":"https://avatars.githubusercontent.com/u/996088?v=4","links":[{"icon":"github","link":"https://github.com/horaklukas"}],"lastFetch":1734600083485},{"username":"pvanagtmaal","name":null,"avatar":"https://avatars.githubusercontent.com/u/5946464?v=4","links":[{"icon":"github","link":"https://github.com/pvanagtmaal"}],"lastFetch":1734600083660},{"username":"toomuchdesign","name":"Andrea Carraro","avatar":"https://avatars.githubusercontent.com/u/4573549?v=4","links":[{"icon":"github","link":"https://github.com/toomuchdesign"}],"lastFetch":1734600083824},{"username":"psychedelicious","name":"psychedelicious","avatar":"https://avatars.githubusercontent.com/u/4822129?v=4","links":[{"icon":"github","link":"https://github.com/psychedelicious"}],"lastFetch":1734600084026},{"username":"tkrotoff","name":"Tanguy Krotoff","avatar":"https://avatars.githubusercontent.com/u/643434?v=4","links":[{"icon":"github","link":"https://github.com/tkrotoff"}],"lastFetch":1734600084213},{"username":"pimveldhuisen","name":"Pim Veldhuisen","avatar":"https://avatars.githubusercontent.com/u/3043834?v=4","links":[{"icon":"github","link":"https://github.com/pimveldhuisen"}],"lastFetch":1734600084370},{"username":"asvishnyakov","name":"Aleksandr Vishniakov","avatar":"https://avatars.githubusercontent.com/u/6369252?v=4","links":[{"icon":"github","link":"https://github.com/asvishnyakov"}],"lastFetch":1734600084545},{"username":"SchabaJo","name":null,"avatar":"https://avatars.githubusercontent.com/u/138689813?v=4","links":[{"icon":"github","link":"https://github.com/SchabaJo"}],"lastFetch":1734600084720},{"username":"AhsanFazal","name":"Ahsan Fazal","avatar":"https://avatars.githubusercontent.com/u/7458046?v=4","links":[{"icon":"github","link":"https://github.com/AhsanFazal"}],"lastFetch":1734600084892},{"username":"ElForastero","name":"Eugene Dzhumak","avatar":"https://avatars.githubusercontent.com/u/5102818?v=4","links":[{"icon":"github","link":"https://github.com/ElForastero"}],"lastFetch":1734600085046},{"username":"msgadi","name":"Mohammed Gadi","avatar":"https://avatars.githubusercontent.com/u/9037086?v=4","links":[{"icon":"github","link":"https://github.com/msgadi"}],"lastFetch":1734600085216},{"username":"muttonchop","name":"Adam K","avatar":"https://avatars.githubusercontent.com/u/1037657?v=4","links":[{"icon":"github","link":"https://github.com/muttonchop"}],"lastFetch":1734600085383},{"username":"christoph-fricke","name":"Christoph Fricke","avatar":"https://avatars.githubusercontent.com/u/23103835?v=4","links":[{"icon":"github","link":"https://github.com/christoph-fricke"}],"lastFetch":1734600085553},{"username":"JorrinKievit","name":"Jorrin","avatar":"https://avatars.githubusercontent.com/u/43169049?v=4","links":[{"icon":"github","link":"https://github.com/JorrinKievit"}],"lastFetch":1734600085722},{"username":"WickyNilliams","name":"Nick Williams","avatar":"https://avatars.githubusercontent.com/u/1091390?v=4","links":[{"icon":"github","link":"https://github.com/WickyNilliams"}],"lastFetch":1734600085919},{"username":"hrsh7th","name":"hrsh7th","avatar":"https://avatars.githubusercontent.com/u/629908?v=4","links":[{"icon":"github","link":"https://github.com/hrsh7th"}],"lastFetch":1734600086085},{"username":"davidleger95","name":"David Leger","avatar":"https://avatars.githubusercontent.com/u/10498708?v=4","links":[{"icon":"github","link":"https://github.com/davidleger95"}],"lastFetch":1729913934448},{"username":"phk422","name":"Hongkun","avatar":"https://avatars.githubusercontent.com/u/59734322?v=4","links":[{"icon":"github","link":"https://github.com/phk422"}],"lastFetch":1734600086253},{"username":"mzronek","name":"Matthias Zronek","avatar":"https://avatars.githubusercontent.com/u/3847700?v=4","links":[{"icon":"github","link":"https://github.com/mzronek"}],"lastFetch":1734600086428},{"username":"raurfang","name":"Łukasz Wiśniewski","avatar":"https://avatars.githubusercontent.com/u/867241?v=4","links":[{"icon":"github","link":"https://github.com/raurfang"}],"lastFetch":1734600086587},{"username":"JeanRemiDelteil","name":"Jean-Rémi Delteil","avatar":"https://avatars.githubusercontent.com/u/9743907?v=4","links":[{"icon":"github","link":"https://github.com/JeanRemiDelteil"}],"lastFetch":1734600086799},{"username":"TzviPM","name":"Tzvi Melamed","avatar":"https://avatars.githubusercontent.com/u/1950680?v=4","links":[{"icon":"github","link":"https://github.com/TzviPM"}],"lastFetch":1734600086987},{"username":"LucaSchwan","name":"ehrenschwan","avatar":"https://avatars.githubusercontent.com/u/25820532?v=4","links":[{"icon":"github","link":"https://github.com/LucaSchwan"}],"lastFetch":1734600087163},{"username":"nzapponi","name":"Niccolo Zapponi","avatar":"https://avatars.githubusercontent.com/u/20582065?v=4","links":[{"icon":"github","link":"https://github.com/nzapponi"}],"lastFetch":1734600087335},{"username":"luchsamapparat","name":"Marvin Luchs","avatar":"https://avatars.githubusercontent.com/u/875017?v=4","links":[{"icon":"github","link":"https://github.com/luchsamapparat"}],"lastFetch":1734600087527},{"username":"nmacmunn","name":"Neil MacMunn","avatar":"https://avatars.githubusercontent.com/u/849964?v=4","links":[{"icon":"github","link":"https://github.com/nmacmunn"}],"lastFetch":1734600087756}],"openapi-fetch":[{"username":"drwpow","name":"Drew Powers","avatar":"https://avatars.githubusercontent.com/u/1369770?v=4","links":[{"icon":"github","link":"https://github.com/drwpow"}],"lastFetch":1734600070626},{"username":"fergusean","name":null,"avatar":"https://avatars.githubusercontent.com/u/1029297?v=4","links":[{"icon":"github","link":"https://github.com/fergusean"}],"lastFetch":1734600070821},{"username":"shinzui","name":"Nadeem Bitar","avatar":"https://avatars.githubusercontent.com/u/519?v=4","links":[{"icon":"github","link":"https://github.com/shinzui"}],"lastFetch":1734600071000},{"username":"ezpuzz","name":"Emory Petermann","avatar":"https://avatars.githubusercontent.com/u/672182?v=4","links":[{"icon":"github","link":"https://github.com/ezpuzz"}],"lastFetch":1734600071191},{"username":"KotoriK","name":null,"avatar":"https://avatars.githubusercontent.com/u/52659125?v=4","links":[{"icon":"github","link":"https://github.com/KotoriK"}],"lastFetch":1734600071365},{"username":"fletchertyler914","name":"Tyler Fletcher","avatar":"https://avatars.githubusercontent.com/u/3344498?v=4","links":[{"icon":"github","link":"https://github.com/fletchertyler914"}],"lastFetch":1734600071575},{"username":"nholik","name":"Nicklos Holik","avatar":"https://avatars.githubusercontent.com/u/2022214?v=4","links":[{"icon":"github","link":"https://github.com/nholik"}],"lastFetch":1734600071737},{"username":"roj1512","name":null,"avatar":"https://avatars.githubusercontent.com/u/175297870?v=4","links":[{"icon":"github","link":"https://github.com/roj1512"}],"lastFetch":1734600071906},{"username":"nickcaballero","name":"Nick Caballero","avatar":"https://avatars.githubusercontent.com/u/355976?v=4","links":[{"icon":"github","link":"https://github.com/nickcaballero"}],"lastFetch":1734600072077},{"username":"hd-o","name":"Hadrian de Oliveira","avatar":"https://avatars.githubusercontent.com/u/58871222?v=4","links":[{"icon":"github","link":"https://github.com/hd-o"}],"lastFetch":1734600072250},{"username":"kecrily","name":"Percy Ma","avatar":"https://avatars.githubusercontent.com/u/45708948?v=4","links":[{"icon":"github","link":"https://github.com/kecrily"}],"lastFetch":1734600072412},{"username":"psychedelicious","name":"psychedelicious","avatar":"https://avatars.githubusercontent.com/u/4822129?v=4","links":[{"icon":"github","link":"https://github.com/psychedelicious"}],"lastFetch":1734600072584},{"username":"muttonchop","name":"Adam K","avatar":"https://avatars.githubusercontent.com/u/1037657?v=4","links":[{"icon":"github","link":"https://github.com/muttonchop"}],"lastFetch":1734600072749},{"username":"marcomuser","name":"Marco Muser","avatar":"https://avatars.githubusercontent.com/u/64737396?v=4","links":[{"icon":"github","link":"https://github.com/marcomuser"}],"lastFetch":1734600072924},{"username":"HugeLetters","name":"Evgenii Perminov","avatar":"https://avatars.githubusercontent.com/u/119697239?v=4","links":[{"icon":"github","link":"https://github.com/HugeLetters"}],"lastFetch":1734600073095},{"username":"Fumaz","name":"alex","avatar":"https://avatars.githubusercontent.com/u/45318608?v=4","links":[{"icon":"github","link":"https://github.com/Fumaz"}],"lastFetch":1734600073281},{"username":"darwish","name":"Mike Darwish","avatar":"https://avatars.githubusercontent.com/u/292570?v=4","links":[{"icon":"github","link":"https://github.com/darwish"}],"lastFetch":1734600073509},{"username":"kaechele","name":"Felix Kaechele","avatar":"https://avatars.githubusercontent.com/u/454490?v=4","links":[{"icon":"github","link":"https://github.com/kaechele"}],"lastFetch":1734600073699},{"username":"phk422","name":"Hongkun","avatar":"https://avatars.githubusercontent.com/u/59734322?v=4","links":[{"icon":"github","link":"https://github.com/phk422"}],"lastFetch":1734600073886},{"username":"mikestopcontinues","name":"Mike Stop Continues","avatar":"https://avatars.githubusercontent.com/u/150434?v=4","links":[{"icon":"github","link":"https://github.com/mikestopcontinues"}],"lastFetch":1734600074057},{"username":"JE-Lee","name":"maurice","avatar":"https://avatars.githubusercontent.com/u/19794813?v=4","links":[{"icon":"github","link":"https://github.com/JE-Lee"}],"lastFetch":1734600074230},{"username":"vipentti","name":"Ville Penttinen","avatar":"https://avatars.githubusercontent.com/u/4726680?v=4","links":[{"icon":"github","link":"https://github.com/vipentti"}],"lastFetch":1734600074400},{"username":"armandabric","name":"Armand Abric","avatar":"https://avatars.githubusercontent.com/u/95120?v=4","links":[{"icon":"github","link":"https://github.com/armandabric"}],"lastFetch":1734600074558},{"username":"illright","name":"Lev Chelyadinov","avatar":"https://avatars.githubusercontent.com/u/15035286?v=4","links":[{"icon":"github","link":"https://github.com/illright"}],"lastFetch":1734600074741}],"openapi-react-query":[{"username":"drwpow","name":"Drew Powers","avatar":"https://avatars.githubusercontent.com/u/1369770?v=4","links":[{"icon":"github","link":"https://github.com/drwpow"}],"lastFetch":1734600070645},{"username":"kerwanp","name":"Martin Paucot","avatar":"https://avatars.githubusercontent.com/u/36955373?v=4","links":[{"icon":"github","link":"https://github.com/kerwanp"}],"lastFetch":1734600070841},{"username":"yoshi2no","name":"yoshi2no","avatar":"https://avatars.githubusercontent.com/u/57059705?v=4","links":[{"icon":"github","link":"https://github.com/yoshi2no"}],"lastFetch":1734600071055},{"username":"elaygelbart","name":"Elay Gelbart","avatar":"https://avatars.githubusercontent.com/u/88675154?v=4","links":[{"icon":"github","link":"https://github.com/elaygelbart"}],"lastFetch":1730904973287},{"username":"HugeLetters","name":"Evgenii Perminov","avatar":"https://avatars.githubusercontent.com/u/119697239?v=4","links":[{"icon":"github","link":"https://github.com/HugeLetters"}],"lastFetch":1734600071262}],"swr-openapi":[{"username":"htunnicliff","name":"Hunter Tunnicliff","avatar":"https://avatars.githubusercontent.com/u/7614039?v=4","links":[{"icon":"github","link":"https://github.com/htunnicliff"}],"lastFetch":1734600070680}],"openapi-metadata":[{"username":"kerwanp","name":"Martin Paucot","avatar":"https://avatars.githubusercontent.com/u/36955373?v=4","links":[{"icon":"github","link":"https://github.com/kerwanp"}],"lastFetch":1734600070676},{"username":"drwpow","name":"Drew Powers","avatar":"https://avatars.githubusercontent.com/u/1369770?v=4","links":[{"icon":"github","link":"https://github.com/drwpow"}],"lastFetch":1734600070876}]} \ No newline at end of file +{"openapi-typescript":[{"username":"drwpow","name":"Drew Powers","avatar":"https://avatars.githubusercontent.com/u/1369770?v=4","links":[{"icon":"github","link":"https://github.com/drwpow"}],"lastFetch":1734801617551},{"username":"psmyrdek","name":"Przemek Smyrdek","avatar":"https://avatars.githubusercontent.com/u/6187417?v=4","links":[{"icon":"github","link":"https://github.com/psmyrdek"}],"lastFetch":1734801617666},{"username":"enmand","name":"Dan Enman","avatar":"https://avatars.githubusercontent.com/u/432487?v=4","links":[{"icon":"github","link":"https://github.com/enmand"}],"lastFetch":1734801617791},{"username":"atlefren","name":"Atle Frenvik Sveen","avatar":"https://avatars.githubusercontent.com/u/1829927?v=4","links":[{"icon":"github","link":"https://github.com/atlefren"}],"lastFetch":1734801617920},{"username":"tpdewolf","name":"Tim de Wolf","avatar":"https://avatars.githubusercontent.com/u/4455209?v=4","links":[{"icon":"github","link":"https://github.com/tpdewolf"}],"lastFetch":1734801618041},{"username":"tombarton","name":"Tom Barton","avatar":"https://avatars.githubusercontent.com/u/6222711?v=4","links":[{"icon":"github","link":"https://github.com/tombarton"}],"lastFetch":1734801618162},{"username":"svnv","name":"Sven Nicolai Viig","avatar":"https://avatars.githubusercontent.com/u/1080888?v=4","links":[{"icon":"github","link":"https://github.com/svnv"}],"lastFetch":1734801618270},{"username":"sorin-davidoi","name":"Sorin Davidoi","avatar":"https://avatars.githubusercontent.com/u/2109702?v=4","links":[{"icon":"github","link":"https://github.com/sorin-davidoi"}],"lastFetch":1734801618379},{"username":"scvnathan","name":"Nathan Schneirov","avatar":"https://avatars.githubusercontent.com/u/73474?v=4","links":[{"icon":"github","link":"https://github.com/scvnathan"}],"lastFetch":1734801618489},{"username":"lbenie","name":"Lucien Bénié","avatar":"https://avatars.githubusercontent.com/u/7316046?v=4","links":[{"icon":"github","link":"https://github.com/lbenie"}],"lastFetch":1734801618622},{"username":"bokub","name":"Boris","avatar":"https://avatars.githubusercontent.com/u/17952318?v=4","links":[{"icon":"github","link":"https://github.com/bokub"}],"lastFetch":1734801618738},{"username":"antonk52","name":"Anton Kastritskii","avatar":"https://avatars.githubusercontent.com/u/5817809?v=4","links":[{"icon":"github","link":"https://github.com/antonk52"}],"lastFetch":1734801618847},{"username":"tshelburne","name":"Tim Shelburne","avatar":"https://avatars.githubusercontent.com/u/1202267?v=4","links":[{"icon":"github","link":"https://github.com/tshelburne"}],"lastFetch":1734801618961},{"username":"typeofweb","name":"Michał Miszczyszyn","avatar":"https://avatars.githubusercontent.com/u/1338731?v=4","links":[{"icon":"github","link":"https://github.com/typeofweb"}],"lastFetch":1734801619072},{"username":"skh-","name":"Sam K Hall","avatar":"https://avatars.githubusercontent.com/u/1292598?v=4","links":[{"icon":"github","link":"https://github.com/skh-"}],"lastFetch":1734801619213},{"username":"BlooJeans","name":"Matt Jeanes","avatar":"https://avatars.githubusercontent.com/u/1751182?v=4","links":[{"icon":"github","link":"https://github.com/BlooJeans"}],"lastFetch":1734801619332},{"username":"selbekk","name":"Kristofer Giltvedt Selbekk","avatar":"https://avatars.githubusercontent.com/u/1307267?v=4","links":[{"icon":"github","link":"https://github.com/selbekk"}],"lastFetch":1734801619469},{"username":"Mause","name":"Elliana May","avatar":"https://avatars.githubusercontent.com/u/1405026?v=4","links":[{"icon":"github","link":"https://github.com/Mause"}],"lastFetch":1734801619582},{"username":"henhal","name":"Henrik Hall","avatar":"https://avatars.githubusercontent.com/u/9608258?v=4","links":[{"icon":"github","link":"https://github.com/henhal"}],"lastFetch":1734801619694},{"username":"gr2m","name":"Gregor Martynus","avatar":"https://avatars.githubusercontent.com/u/39992?v=4","links":[{"icon":"github","link":"https://github.com/gr2m"}],"lastFetch":1734801619816},{"username":"samdbmg","name":"Sam Mesterton-Gibbons","avatar":"https://avatars.githubusercontent.com/u/408983?v=4","links":[{"icon":"github","link":"https://github.com/samdbmg"}],"lastFetch":1734801619934},{"username":"rendall","name":"Rendall","avatar":"https://avatars.githubusercontent.com/u/293263?v=4","links":[{"icon":"github","link":"https://github.com/rendall"}],"lastFetch":1734801620046},{"username":"robertmassaioli","name":"Robert Massaioli","avatar":"https://avatars.githubusercontent.com/u/149178?v=4","links":[{"icon":"github","link":"https://github.com/robertmassaioli"}],"lastFetch":1734801620154},{"username":"jankuca","name":"Jan Kuča","avatar":"https://avatars.githubusercontent.com/u/367262?v=4","links":[{"icon":"github","link":"https://github.com/jankuca"}],"lastFetch":1734801620265},{"username":"th-m","name":"Thomas Valadez","avatar":"https://avatars.githubusercontent.com/u/13792029?v=4","links":[{"icon":"github","link":"https://github.com/th-m"}],"lastFetch":1734801620391},{"username":"asithade","name":"Asitha de Silva","avatar":"https://avatars.githubusercontent.com/u/3814354?v=4","links":[{"icon":"github","link":"https://github.com/asithade"}],"lastFetch":1734801620511},{"username":"misha-erm","name":"Misha","avatar":"https://avatars.githubusercontent.com/u/8783498?v=4","links":[{"icon":"github","link":"https://github.com/misha-erm"}],"lastFetch":1734801620633},{"username":"radist2s","name":"Alex Batalov","avatar":"https://avatars.githubusercontent.com/u/725645?v=4","links":[{"icon":"github","link":"https://github.com/radist2s"}],"lastFetch":1734801620750},{"username":"FedeBev","name":"Federico Bevione","avatar":"https://avatars.githubusercontent.com/u/22151395?v=4","links":[{"icon":"github","link":"https://github.com/FedeBev"}],"lastFetch":1734801620868},{"username":"yamacent","name":"Daisuke Yamamoto","avatar":"https://avatars.githubusercontent.com/u/8544439?v=4","links":[{"icon":"github","link":"https://github.com/yamacent"}],"lastFetch":1734801620976},{"username":"dnalborczyk","name":null,"avatar":"https://avatars.githubusercontent.com/u/2903325?v=4","links":[{"icon":"github","link":"https://github.com/dnalborczyk"}],"lastFetch":1734801621113},{"username":"FabioWanner","name":null,"avatar":"https://avatars.githubusercontent.com/u/46821078?v=4","links":[{"icon":"github","link":"https://github.com/FabioWanner"}],"lastFetch":1734801621228},{"username":"ashsmith","name":"Ash Smith","avatar":"https://avatars.githubusercontent.com/u/1086841?v=4","links":[{"icon":"github","link":"https://github.com/ashsmith"}],"lastFetch":1734801621359},{"username":"mehalter","name":"Micah Halter","avatar":"https://avatars.githubusercontent.com/u/1591837?v=4","links":[{"icon":"github","link":"https://github.com/mehalter"}],"lastFetch":1734801621488},{"username":"Chrg1001","name":"chrg1001","avatar":"https://avatars.githubusercontent.com/u/40189653?v=4","links":[{"icon":"github","link":"https://github.com/Chrg1001"}],"lastFetch":1734801621609},{"username":"sharmarajdaksh","name":"Dakshraj Sharma","avatar":"https://avatars.githubusercontent.com/u/33689528?v=4","links":[{"icon":"github","link":"https://github.com/sharmarajdaksh"}],"lastFetch":1734801621731},{"username":"shuluster","name":"Shaosu Liu","avatar":"https://avatars.githubusercontent.com/u/1707910?v=4","links":[{"icon":"github","link":"https://github.com/shuluster"}],"lastFetch":1734801621848},{"username":"FDiskas","name":"Vytenis","avatar":"https://avatars.githubusercontent.com/u/468006?v=4","links":[{"icon":"github","link":"https://github.com/FDiskas"}],"lastFetch":1734801621964},{"username":"ericzorn93","name":"Eric Zorn","avatar":"https://avatars.githubusercontent.com/u/22532542?v=4","links":[{"icon":"github","link":"https://github.com/ericzorn93"}],"lastFetch":1734801622118},{"username":"mbelsky","name":"Max Belsky","avatar":"https://avatars.githubusercontent.com/u/3923527?v=4","links":[{"icon":"github","link":"https://github.com/mbelsky"}],"lastFetch":1734801622240},{"username":"techbech","name":"Peter Bech","avatar":"https://avatars.githubusercontent.com/u/1520592?v=4","links":[{"icon":"github","link":"https://github.com/techbech"}],"lastFetch":1734801622346},{"username":"rustyconover","name":"Rusty Conover","avatar":"https://avatars.githubusercontent.com/u/731941?v=4","links":[{"icon":"github","link":"https://github.com/rustyconover"}],"lastFetch":1734801622457},{"username":"bunkscene","name":"Dave Carlson","avatar":"https://avatars.githubusercontent.com/u/2693678?v=4","links":[{"icon":"github","link":"https://github.com/bunkscene"}],"lastFetch":1734801622577},{"username":"ottomated","name":null,"avatar":"https://avatars.githubusercontent.com/u/31470743?v=4","links":[{"icon":"github","link":"https://github.com/ottomated"}],"lastFetch":1734801622715},{"username":"sadfsdfdsa","name":"Artem Shuvaev","avatar":"https://avatars.githubusercontent.com/u/28733669?v=4","links":[{"icon":"github","link":"https://github.com/sadfsdfdsa"}],"lastFetch":1734801622838},{"username":"ajaishankar","name":null,"avatar":"https://avatars.githubusercontent.com/u/328008?v=4","links":[{"icon":"github","link":"https://github.com/ajaishankar"}],"lastFetch":1734801622956},{"username":"dominikdosoudil","name":"Dominik Dosoudil","avatar":"https://avatars.githubusercontent.com/u/15929942?v=4","links":[{"icon":"github","link":"https://github.com/dominikdosoudil"}],"lastFetch":1734801623070},{"username":"kgtkr","name":"kgtkr","avatar":"https://avatars.githubusercontent.com/u/17868838?v=4","links":[{"icon":"github","link":"https://github.com/kgtkr"}],"lastFetch":1734801623189},{"username":"berzi","name":null,"avatar":"https://avatars.githubusercontent.com/u/32619123?v=4","links":[{"icon":"github","link":"https://github.com/berzi"}],"lastFetch":1734801623315},{"username":"PhilipTrauner","name":"philip trauner","avatar":"https://avatars.githubusercontent.com/u/9287847?v=4","links":[{"icon":"github","link":"https://github.com/PhilipTrauner"}],"lastFetch":1734801623434},{"username":"Powell-v2","name":"Pavel Yermolin","avatar":"https://avatars.githubusercontent.com/u/25308326?v=4","links":[{"icon":"github","link":"https://github.com/Powell-v2"}],"lastFetch":1734801623551},{"username":"duncanbeevers","name":"Duncan Beevers","avatar":"https://avatars.githubusercontent.com/u/7367?v=4","links":[{"icon":"github","link":"https://github.com/duncanbeevers"}],"lastFetch":1734801623670},{"username":"tkukushkin","name":"Timofei Kukushkin","avatar":"https://avatars.githubusercontent.com/u/1482516?v=4","links":[{"icon":"github","link":"https://github.com/tkukushkin"}],"lastFetch":1734801623775},{"username":"Semigradsky","name":"Dmitry Semigradsky","avatar":"https://avatars.githubusercontent.com/u/1198848?v=4","links":[{"icon":"github","link":"https://github.com/Semigradsky"}],"lastFetch":1734801623894},{"username":"MrLeebo","name":"Jeremy Liberman","avatar":"https://avatars.githubusercontent.com/u/2754163?v=4","links":[{"icon":"github","link":"https://github.com/MrLeebo"}],"lastFetch":1734801624010},{"username":"axelhzf","name":"Axel Hernández Ferrera","avatar":"https://avatars.githubusercontent.com/u/175627?v=4","links":[{"icon":"github","link":"https://github.com/axelhzf"}],"lastFetch":1734801624127},{"username":"imagoiq","name":"Loïc Fürhoff","avatar":"https://avatars.githubusercontent.com/u/12294151?v=4","links":[{"icon":"github","link":"https://github.com/imagoiq"}],"lastFetch":1734801624246},{"username":"BTMPL","name":"Bartosz Szczeciński","avatar":"https://avatars.githubusercontent.com/u/247153?v=4","links":[{"icon":"github","link":"https://github.com/BTMPL"}],"lastFetch":1734801624356},{"username":"HiiiiD","name":"Marco Salomone","avatar":"https://avatars.githubusercontent.com/u/61231210?v=4","links":[{"icon":"github","link":"https://github.com/HiiiiD"}],"lastFetch":1734801624485},{"username":"yacinehmito","name":"Yacine Hmito","avatar":"https://avatars.githubusercontent.com/u/6893840?v=4","links":[{"icon":"github","link":"https://github.com/yacinehmito"}],"lastFetch":1734801624604},{"username":"sajadtorkamani","name":"Sajad Torkamani","avatar":"https://avatars.githubusercontent.com/u/9380313?v=4","links":[{"icon":"github","link":"https://github.com/sajadtorkamani"}],"lastFetch":1734801624722},{"username":"mvdbeek","name":"Marius van den Beek","avatar":"https://avatars.githubusercontent.com/u/6804901?v=4","links":[{"icon":"github","link":"https://github.com/mvdbeek"}],"lastFetch":1734801624870},{"username":"sgrimm","name":"Steven Grimm","avatar":"https://avatars.githubusercontent.com/u/1248649?v=4","links":[{"icon":"github","link":"https://github.com/sgrimm"}],"lastFetch":1734801625008},{"username":"Swiftwork","name":"Erik Hughes","avatar":"https://avatars.githubusercontent.com/u/455178?v=4","links":[{"icon":"github","link":"https://github.com/Swiftwork"}],"lastFetch":1734801625117},{"username":"mtth","name":"Matthieu Monsch","avatar":"https://avatars.githubusercontent.com/u/1216372?v=4","links":[{"icon":"github","link":"https://github.com/mtth"}],"lastFetch":1734801625237},{"username":"mitchell-merry","name":"Mitchell Merry","avatar":"https://avatars.githubusercontent.com/u/8567231?v=4","links":[{"icon":"github","link":"https://github.com/mitchell-merry"}],"lastFetch":1734801625350},{"username":"qnp","name":"François Risoud","avatar":"https://avatars.githubusercontent.com/u/6012554?v=4","links":[{"icon":"github","link":"https://github.com/qnp"}],"lastFetch":1734801625465},{"username":"shoffmeister","name":null,"avatar":"https://avatars.githubusercontent.com/u/3868036?v=4","links":[{"icon":"github","link":"https://github.com/shoffmeister"}],"lastFetch":1734801625600},{"username":"liangskyli","name":"liangsky","avatar":"https://avatars.githubusercontent.com/u/31531283?v=4","links":[{"icon":"github","link":"https://github.com/liangskyli"}],"lastFetch":1734801625703},{"username":"happycollision","name":"Don Denton","avatar":"https://avatars.githubusercontent.com/u/3663628?v=4","links":[{"icon":"github","link":"https://github.com/happycollision"}],"lastFetch":1734801625818},{"username":"ysmood","name":"Yad Smood","avatar":"https://avatars.githubusercontent.com/u/1415488?v=4","links":[{"icon":"github","link":"https://github.com/ysmood"}],"lastFetch":1734801625940},{"username":"barakalon","name":"barak","avatar":"https://avatars.githubusercontent.com/u/12398927?v=4","links":[{"icon":"github","link":"https://github.com/barakalon"}],"lastFetch":1734801626064},{"username":"horaklukas","name":"Lukáš Horák","avatar":"https://avatars.githubusercontent.com/u/996088?v=4","links":[{"icon":"github","link":"https://github.com/horaklukas"}],"lastFetch":1734801626181},{"username":"pvanagtmaal","name":null,"avatar":"https://avatars.githubusercontent.com/u/5946464?v=4","links":[{"icon":"github","link":"https://github.com/pvanagtmaal"}],"lastFetch":1734801626328},{"username":"toomuchdesign","name":"Andrea Carraro","avatar":"https://avatars.githubusercontent.com/u/4573549?v=4","links":[{"icon":"github","link":"https://github.com/toomuchdesign"}],"lastFetch":1734801626506},{"username":"psychedelicious","name":"psychedelicious","avatar":"https://avatars.githubusercontent.com/u/4822129?v=4","links":[{"icon":"github","link":"https://github.com/psychedelicious"}],"lastFetch":1734801626625},{"username":"tkrotoff","name":"Tanguy Krotoff","avatar":"https://avatars.githubusercontent.com/u/643434?v=4","links":[{"icon":"github","link":"https://github.com/tkrotoff"}],"lastFetch":1734801626741},{"username":"pimveldhuisen","name":"Pim Veldhuisen","avatar":"https://avatars.githubusercontent.com/u/3043834?v=4","links":[{"icon":"github","link":"https://github.com/pimveldhuisen"}],"lastFetch":1734801626854},{"username":"asvishnyakov","name":"Aleksandr Vishniakov","avatar":"https://avatars.githubusercontent.com/u/6369252?v=4","links":[{"icon":"github","link":"https://github.com/asvishnyakov"}],"lastFetch":1734801626966},{"username":"SchabaJo","name":null,"avatar":"https://avatars.githubusercontent.com/u/138689813?v=4","links":[{"icon":"github","link":"https://github.com/SchabaJo"}],"lastFetch":1734801627082},{"username":"AhsanFazal","name":"Ahsan Fazal","avatar":"https://avatars.githubusercontent.com/u/7458046?v=4","links":[{"icon":"github","link":"https://github.com/AhsanFazal"}],"lastFetch":1734801627190},{"username":"ElForastero","name":"Eugene Dzhumak","avatar":"https://avatars.githubusercontent.com/u/5102818?v=4","links":[{"icon":"github","link":"https://github.com/ElForastero"}],"lastFetch":1734801627304},{"username":"msgadi","name":"Mohammed Gadi","avatar":"https://avatars.githubusercontent.com/u/9037086?v=4","links":[{"icon":"github","link":"https://github.com/msgadi"}],"lastFetch":1734801627421},{"username":"muttonchop","name":"Adam K","avatar":"https://avatars.githubusercontent.com/u/1037657?v=4","links":[{"icon":"github","link":"https://github.com/muttonchop"}],"lastFetch":1734801627546},{"username":"christoph-fricke","name":"Christoph Fricke","avatar":"https://avatars.githubusercontent.com/u/23103835?v=4","links":[{"icon":"github","link":"https://github.com/christoph-fricke"}],"lastFetch":1734801627663},{"username":"JorrinKievit","name":"Jorrin","avatar":"https://avatars.githubusercontent.com/u/43169049?v=4","links":[{"icon":"github","link":"https://github.com/JorrinKievit"}],"lastFetch":1734801627794},{"username":"WickyNilliams","name":"Nick Williams","avatar":"https://avatars.githubusercontent.com/u/1091390?v=4","links":[{"icon":"github","link":"https://github.com/WickyNilliams"}],"lastFetch":1734801627924},{"username":"hrsh7th","name":"hrsh7th","avatar":"https://avatars.githubusercontent.com/u/629908?v=4","links":[{"icon":"github","link":"https://github.com/hrsh7th"}],"lastFetch":1734801628050},{"username":"davidleger95","name":"David Leger","avatar":"https://avatars.githubusercontent.com/u/10498708?v=4","links":[{"icon":"github","link":"https://github.com/davidleger95"}],"lastFetch":1729913934448},{"username":"phk422","name":"Hongkun","avatar":"https://avatars.githubusercontent.com/u/59734322?v=4","links":[{"icon":"github","link":"https://github.com/phk422"}],"lastFetch":1734801628179},{"username":"mzronek","name":"Matthias Zronek","avatar":"https://avatars.githubusercontent.com/u/3847700?v=4","links":[{"icon":"github","link":"https://github.com/mzronek"}],"lastFetch":1734801628293},{"username":"raurfang","name":"Łukasz Wiśniewski","avatar":"https://avatars.githubusercontent.com/u/867241?v=4","links":[{"icon":"github","link":"https://github.com/raurfang"}],"lastFetch":1734801628405},{"username":"JeanRemiDelteil","name":"Jean-Rémi Delteil","avatar":"https://avatars.githubusercontent.com/u/9743907?v=4","links":[{"icon":"github","link":"https://github.com/JeanRemiDelteil"}],"lastFetch":1734801628540},{"username":"TzviPM","name":"Tzvi Melamed","avatar":"https://avatars.githubusercontent.com/u/1950680?v=4","links":[{"icon":"github","link":"https://github.com/TzviPM"}],"lastFetch":1734801628649},{"username":"LucaSchwan","name":"ehrenschwan","avatar":"https://avatars.githubusercontent.com/u/25820532?v=4","links":[{"icon":"github","link":"https://github.com/LucaSchwan"}],"lastFetch":1734801628766},{"username":"nzapponi","name":"Niccolo Zapponi","avatar":"https://avatars.githubusercontent.com/u/20582065?v=4","links":[{"icon":"github","link":"https://github.com/nzapponi"}],"lastFetch":1734801628877},{"username":"luchsamapparat","name":"Marvin Luchs","avatar":"https://avatars.githubusercontent.com/u/875017?v=4","links":[{"icon":"github","link":"https://github.com/luchsamapparat"}],"lastFetch":1734801628998},{"username":"nmacmunn","name":"Neil MacMunn","avatar":"https://avatars.githubusercontent.com/u/849964?v=4","links":[{"icon":"github","link":"https://github.com/nmacmunn"}],"lastFetch":1734801629119}],"openapi-fetch":[{"username":"drwpow","name":"Drew Powers","avatar":"https://avatars.githubusercontent.com/u/1369770?v=4","links":[{"icon":"github","link":"https://github.com/drwpow"}],"lastFetch":1734801617559},{"username":"fergusean","name":null,"avatar":"https://avatars.githubusercontent.com/u/1029297?v=4","links":[{"icon":"github","link":"https://github.com/fergusean"}],"lastFetch":1734801617666},{"username":"shinzui","name":"Nadeem Bitar","avatar":"https://avatars.githubusercontent.com/u/519?v=4","links":[{"icon":"github","link":"https://github.com/shinzui"}],"lastFetch":1734801617790},{"username":"ezpuzz","name":"Emory Petermann","avatar":"https://avatars.githubusercontent.com/u/672182?v=4","links":[{"icon":"github","link":"https://github.com/ezpuzz"}],"lastFetch":1734801617900},{"username":"KotoriK","name":null,"avatar":"https://avatars.githubusercontent.com/u/52659125?v=4","links":[{"icon":"github","link":"https://github.com/KotoriK"}],"lastFetch":1734801618010},{"username":"fletchertyler914","name":"Tyler Fletcher","avatar":"https://avatars.githubusercontent.com/u/3344498?v=4","links":[{"icon":"github","link":"https://github.com/fletchertyler914"}],"lastFetch":1734801618138},{"username":"nholik","name":"Nicklos Holik","avatar":"https://avatars.githubusercontent.com/u/2022214?v=4","links":[{"icon":"github","link":"https://github.com/nholik"}],"lastFetch":1734801618253},{"username":"roj1512","name":null,"avatar":"https://avatars.githubusercontent.com/u/175297870?v=4","links":[{"icon":"github","link":"https://github.com/roj1512"}],"lastFetch":1734801618358},{"username":"nickcaballero","name":"Nick Caballero","avatar":"https://avatars.githubusercontent.com/u/355976?v=4","links":[{"icon":"github","link":"https://github.com/nickcaballero"}],"lastFetch":1734801618472},{"username":"hd-o","name":"Hadrian de Oliveira","avatar":"https://avatars.githubusercontent.com/u/58871222?v=4","links":[{"icon":"github","link":"https://github.com/hd-o"}],"lastFetch":1734801618596},{"username":"kecrily","name":"Percy Ma","avatar":"https://avatars.githubusercontent.com/u/45708948?v=4","links":[{"icon":"github","link":"https://github.com/kecrily"}],"lastFetch":1734801618710},{"username":"psychedelicious","name":"psychedelicious","avatar":"https://avatars.githubusercontent.com/u/4822129?v=4","links":[{"icon":"github","link":"https://github.com/psychedelicious"}],"lastFetch":1734801618824},{"username":"muttonchop","name":"Adam K","avatar":"https://avatars.githubusercontent.com/u/1037657?v=4","links":[{"icon":"github","link":"https://github.com/muttonchop"}],"lastFetch":1734801618965},{"username":"marcomuser","name":"Marco Muser","avatar":"https://avatars.githubusercontent.com/u/64737396?v=4","links":[{"icon":"github","link":"https://github.com/marcomuser"}],"lastFetch":1734801619081},{"username":"HugeLetters","name":"Evgenii Perminov","avatar":"https://avatars.githubusercontent.com/u/119697239?v=4","links":[{"icon":"github","link":"https://github.com/HugeLetters"}],"lastFetch":1734801619189},{"username":"Fumaz","name":"alex","avatar":"https://avatars.githubusercontent.com/u/45318608?v=4","links":[{"icon":"github","link":"https://github.com/Fumaz"}],"lastFetch":1734801619306},{"username":"darwish","name":"Mike Darwish","avatar":"https://avatars.githubusercontent.com/u/292570?v=4","links":[{"icon":"github","link":"https://github.com/darwish"}],"lastFetch":1734801619460},{"username":"kaechele","name":"Felix Kaechele","avatar":"https://avatars.githubusercontent.com/u/454490?v=4","links":[{"icon":"github","link":"https://github.com/kaechele"}],"lastFetch":1734801619580},{"username":"phk422","name":"Hongkun","avatar":"https://avatars.githubusercontent.com/u/59734322?v=4","links":[{"icon":"github","link":"https://github.com/phk422"}],"lastFetch":1734801619698},{"username":"mikestopcontinues","name":"Mike Stop Continues","avatar":"https://avatars.githubusercontent.com/u/150434?v=4","links":[{"icon":"github","link":"https://github.com/mikestopcontinues"}],"lastFetch":1734801619814},{"username":"JE-Lee","name":"maurice","avatar":"https://avatars.githubusercontent.com/u/19794813?v=4","links":[{"icon":"github","link":"https://github.com/JE-Lee"}],"lastFetch":1734801619930},{"username":"vipentti","name":"Ville Penttinen","avatar":"https://avatars.githubusercontent.com/u/4726680?v=4","links":[{"icon":"github","link":"https://github.com/vipentti"}],"lastFetch":1734801620042},{"username":"armandabric","name":"Armand Abric","avatar":"https://avatars.githubusercontent.com/u/95120?v=4","links":[{"icon":"github","link":"https://github.com/armandabric"}],"lastFetch":1734801620160},{"username":"illright","name":"Lev Chelyadinov","avatar":"https://avatars.githubusercontent.com/u/15035286?v=4","links":[{"icon":"github","link":"https://github.com/illright"}],"lastFetch":1734801620270}],"openapi-react-query":[{"username":"drwpow","name":"Drew Powers","avatar":"https://avatars.githubusercontent.com/u/1369770?v=4","links":[{"icon":"github","link":"https://github.com/drwpow"}],"lastFetch":1734801617558},{"username":"kerwanp","name":"Martin Paucot","avatar":"https://avatars.githubusercontent.com/u/36955373?v=4","links":[{"icon":"github","link":"https://github.com/kerwanp"}],"lastFetch":1734801617693},{"username":"yoshi2no","name":"yoshi2no","avatar":"https://avatars.githubusercontent.com/u/57059705?v=4","links":[{"icon":"github","link":"https://github.com/yoshi2no"}],"lastFetch":1734801617809},{"username":"elaygelbart","name":"Elay Gelbart","avatar":"https://avatars.githubusercontent.com/u/88675154?v=4","links":[{"icon":"github","link":"https://github.com/elaygelbart"}],"lastFetch":1730904973287},{"username":"HugeLetters","name":"Evgenii Perminov","avatar":"https://avatars.githubusercontent.com/u/119697239?v=4","links":[{"icon":"github","link":"https://github.com/HugeLetters"}],"lastFetch":1734801617950}],"swr-openapi":[{"username":"htunnicliff","name":"Hunter Tunnicliff","avatar":"https://avatars.githubusercontent.com/u/7614039?v=4","links":[{"icon":"github","link":"https://github.com/htunnicliff"}],"lastFetch":1734801617545}],"openapi-metadata":[{"username":"kerwanp","name":"Martin Paucot","avatar":"https://avatars.githubusercontent.com/u/36955373?v=4","links":[{"icon":"github","link":"https://github.com/kerwanp"}],"lastFetch":1734801617553},{"username":"drwpow","name":"Drew Powers","avatar":"https://avatars.githubusercontent.com/u/1369770?v=4","links":[{"icon":"github","link":"https://github.com/drwpow"}],"lastFetch":1734801617665}]} \ No newline at end of file diff --git a/docs/package.json b/docs/package.json index 90ff6c1f0..450d93cf4 100644 --- a/docs/package.json +++ b/docs/package.json @@ -11,7 +11,7 @@ "devDependencies": { "@shikijs/vitepress-twoslash": "^1.24.3", "openapi-metadata": "workspace:*", - "vite": "^6.0.4", + "vite": "^6.0.5", "vitepress": "1.5.0" } } diff --git a/packages/openapi-fetch/examples/sveltekit/package.json b/packages/openapi-fetch/examples/sveltekit/package.json index 0ba77a360..f58440fe3 100644 --- a/packages/openapi-fetch/examples/sveltekit/package.json +++ b/packages/openapi-fetch/examples/sveltekit/package.json @@ -8,17 +8,18 @@ "check:watch": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json --watch" }, "dependencies": { + "@sveltejs/vite-plugin-svelte-inspector": "^4.0.1", "openapi-fetch": "workspace:^" }, "devDependencies": { "@sveltejs/adapter-auto": "^3.3.1", - "@sveltejs/kit": "^2.9.0", - "@sveltejs/vite-plugin-svelte": "^3.1.2", + "@sveltejs/kit": "^2.13.0", + "@sveltejs/vite-plugin-svelte": "^5.0.3", "openapi-typescript": "workspace:^", - "svelte": "^4.2.19", + "svelte": "^5.15.0", "svelte-check": "^3.8.6", "tslib": "^2.8.1", "typescript": "^5.7.2", - "vite": "^6.0.4" + "vite": "^6.0.5" } } diff --git a/packages/openapi-fetch/test/examples/schemas/github.d.ts b/packages/openapi-fetch/test/examples/schemas/github.d.ts index 9906eb7f0..b4eb2bae5 100644 --- a/packages/openapi-fetch/test/examples/schemas/github.d.ts +++ b/packages/openapi-fetch/test/examples/schemas/github.d.ts @@ -289,8 +289,6 @@ export interface paths { * * Optionally, use the `permissions` body parameter to specify the permissions that the installation access token should have. If `permissions` is not specified, the installation access token will have all of the permissions that were granted to the app. The installation access token cannot be granted permissions that the app was not granted. * - * When using the repository or permission parameters to reduce the access of the token, the complexity of the token is increased due to both the number of permissions in the request and the number of repositories the token will have access to. If the complexity is too large, the token will fail to be issued. If this occurs, the error message will indicate the maximum number of repositories that should be requested. For the average application requesting 8 permissions, this limit is around 5000 repositories. With fewer permissions requested, more repositories are supported. - * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ post: operations["apps/create-installation-access-token"]; @@ -602,7 +600,7 @@ export interface paths { patch?: never; trace?: never; }; - "/enterprises/{enterprise}/copilot/billing/seats": { + "/enterprises/{enterprise}/code-security/configurations": { parameters: { query?: never; header?: never; @@ -610,33 +608,31 @@ export interface paths { cookie?: never; }; /** - * List all Copilot seat assignments for an enterprise - * @description > [!NOTE] - * > This endpoint is in public preview and is subject to change. + * Get code security configurations for an enterprise + * @description Lists all code security configurations available in an enterprise. * - * Lists all Copilot seats currently being billed for across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription. + * The authenticated user must be an administrator of the enterprise in order to use this endpoint. * - * Users with access through multiple organizations or enterprise teams will only be counted toward `total_seats` once. - * - * For each organization or enterprise team which grants Copilot access to a user, a seat detail object will appear in the `seats` array. - * Each seat object contains information about the assigned user's most recent Copilot activity. Users must have - * telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. For more information about activity data, - * see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." + * OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. + */ + get: operations["code-security/get-configurations-for-enterprise"]; + put?: never; + /** + * Create a code security configuration for an enterprise + * @description Creates a code security configuration in an enterprise. * - * Only enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams. + * The authenticated user must be an administrator of the enterprise in order to use this endpoint. * - * Personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ - get: operations["copilot/list-copilot-seats-for-enterprise"]; - put?: never; - post?: never; + post: operations["code-security/create-configuration-for-enterprise"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/enterprises/{enterprise}/copilot/metrics": { + "/enterprises/{enterprise}/code-security/configurations/defaults": { parameters: { query?: never; header?: never; @@ -644,19 +640,14 @@ export interface paths { cookie?: never; }; /** - * Get Copilot metrics for an enterprise - * @description Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. - * - * The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, - * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, - * they must have telemetry enabled in their IDE. + * Get default code security configurations for an enterprise + * @description Lists the default code security configurations for an enterprise. * - * To access this endpoint, the Copilot Metrics API access policy must be enabled or set to "no policy" for the enterprise within GitHub settings. - * Only enterprise owners and billing managers can view Copilot metrics for the enterprise. + * The authenticated user must be an administrator of the enterprise in order to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. */ - get: operations["copilot/copilot-metrics-for-enterprise"]; + get: operations["code-security/get-default-configurations-for-enterprise"]; put?: never; post?: never; delete?: never; @@ -665,7 +656,7 @@ export interface paths { patch?: never; trace?: never; }; - "/enterprises/{enterprise}/copilot/usage": { + "/enterprises/{enterprise}/code-security/configurations/{configuration_id}": { parameters: { query?: never; header?: never; @@ -673,52 +664,85 @@ export interface paths { cookie?: never; }; /** - * Get a summary of Copilot usage for enterprise members - * @description > [!NOTE] - * > This endpoint is in public preview and is subject to change. + * Retrieve a code security configuration of an enterprise + * @description Gets a code security configuration available in an enterprise. * - * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE - * for all users across organizations with access to Copilot within your enterprise, with a further breakdown of suggestions, acceptances, - * and number of active users by editor and language for each day. See the response schema tab for detailed metrics definitions. + * The authenticated user must be an administrator of the enterprise in order to use this endpoint. * - * The response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day, - * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, - * they must have telemetry enabled in their IDE. + * OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. + */ + get: operations["code-security/get-single-configuration-for-enterprise"]; + put?: never; + post?: never; + /** + * Delete a code security configuration for an enterprise + * @description Deletes a code security configuration from an enterprise. + * Repositories attached to the configuration will retain their settings but will no longer be associated with + * the configuration. + * + * The authenticated user must be an administrator for the enterprise to use this endpoint. * - * The time zone in the response is in UTC time, that means that the cutoff time for the "day" is UTC time. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + */ + delete: operations["code-security/delete-configuration-for-enterprise"]; + options?: never; + head?: never; + /** + * Update a custom code security configuration for an enterprise + * @description Updates a code security configuration in an enterprise. * - * Only owners and billing managers can view Copilot usage metrics for the enterprise. + * The authenticated user must be an administrator of the enterprise in order to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ - get: operations["copilot/usage-metrics-for-enterprise"]; + patch: operations["code-security/update-enterprise-configuration"]; + trace?: never; + }; + "/enterprises/{enterprise}/code-security/configurations/{configuration_id}/attach": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; put?: never; - post?: never; + /** + * Attach an enterprise configuration to repositories + * @description Attaches an enterprise code security configuration to repositories. If the repositories specified are already attached to a configuration, they will be re-attached to the provided configuration. + * + * If insufficient GHAS licenses are available to attach the configuration to a repository, only free features will be enabled. + * + * The authenticated user must be an administrator for the enterprise to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + */ + post: operations["code-security/attach-enterprise-configuration"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/enterprises/{enterprise}/dependabot/alerts": { + "/enterprises/{enterprise}/code-security/configurations/{configuration_id}/defaults": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; + get?: never; /** - * List Dependabot alerts for an enterprise - * @description Lists Dependabot alerts for repositories that are owned by the specified enterprise. + * Set a code security configuration as a default for an enterprise + * @description Sets a code security configuration as a default to be applied to new repositories in your enterprise. * - * The authenticated user must be a member of the enterprise to use this endpoint. + * This configuration will be applied by default to the matching repository type when created, but only for organizations within the enterprise that do not already have a default code security configuration set. * - * Alerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager. For more information about security managers, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * The authenticated user must be an administrator for the enterprise to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ - get: operations["dependabot/list-alerts-for-enterprise"]; - put?: never; + put: operations["code-security/set-configuration-as-default-for-enterprise"]; post?: never; delete?: never; options?: never; @@ -726,7 +750,7 @@ export interface paths { patch?: never; trace?: never; }; - "/enterprises/{enterprise}/secret-scanning/alerts": { + "/enterprises/{enterprise}/code-security/configurations/{configuration_id}/repositories": { parameters: { query?: never; header?: never; @@ -734,16 +758,14 @@ export interface paths { cookie?: never; }; /** - * List secret scanning alerts for an enterprise - * @description Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest. - * - * Alerts are only returned for organizations in the enterprise for which the authenticated user is an organization owner or a [security manager](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization). + * Get repositories associated with an enterprise code security configuration + * @description Lists the repositories associated with an enterprise code security configuration in an organization. * - * The authenticated user must be a member of the enterprise in order to use this endpoint. + * The authenticated user must be an administrator of the enterprise in order to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope or `security_events` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. */ - get: operations["secret-scanning/list-alerts-for-enterprise"]; + get: operations["code-security/get-repositories-for-enterprise-configuration"]; put?: never; post?: never; delete?: never; @@ -752,7 +774,7 @@ export interface paths { patch?: never; trace?: never; }; - "/enterprises/{enterprise}/team/{team_slug}/copilot/metrics": { + "/enterprises/{enterprise}/dependabot/alerts": { parameters: { query?: never; header?: never; @@ -760,22 +782,16 @@ export interface paths { cookie?: never; }; /** - * Get Copilot metrics for an enterprise team - * @description Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. - * - * The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, - * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, - * they must have telemetry enabled in their IDE. + * List Dependabot alerts for an enterprise + * @description Lists Dependabot alerts for repositories that are owned by the specified enterprise. * - * > [!NOTE] - * > This endpoint will only return results for a given day if the enterprise team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day. + * The authenticated user must be a member of the enterprise to use this endpoint. * - * To access this endpoint, the Copilot Metrics API access policy must be enabled or set to "no policy" for the enterprise within GitHub settings. - * Only owners and billing managers for the enterprise that contains the enterprise team can view Copilot metrics for the enterprise team. + * Alerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager. For more information about security managers, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. */ - get: operations["copilot/copilot-metrics-for-enterprise-team"]; + get: operations["dependabot/list-alerts-for-enterprise"]; put?: never; post?: never; delete?: never; @@ -784,7 +800,7 @@ export interface paths { patch?: never; trace?: never; }; - "/enterprises/{enterprise}/team/{team_slug}/copilot/usage": { + "/enterprises/{enterprise}/secret-scanning/alerts": { parameters: { query?: never; header?: never; @@ -792,26 +808,16 @@ export interface paths { cookie?: never; }; /** - * Get a summary of Copilot usage for an enterprise team - * @description > [!NOTE] - * > This endpoint is in public preview and is subject to change. - * - * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE - * for users within an enterprise team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day. - * See the response schema tab for detailed metrics definitions. - * - * The response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day, - * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, - * they must have telemetry enabled in their IDE. + * List secret scanning alerts for an enterprise + * @description Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest. * - * > [!NOTE] - * > This endpoint will only return results for a given day if the enterprise team had five or more members with active Copilot licenses, as evaluated at the end of that day. + * Alerts are only returned for organizations in the enterprise for which the authenticated user is an organization owner or a [security manager](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization). * - * Owners and billing managers for the enterprise that contains the enterprise team can view Copilot usage metrics for the enterprise team. + * The authenticated user must be a member of the enterprise in order to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope or `security_events` scope to use this endpoint. */ - get: operations["copilot/usage-metrics-for-enterprise-team"]; + get: operations["secret-scanning/list-alerts-for-enterprise"]; put?: never; post?: never; delete?: never; @@ -1637,6 +1643,28 @@ export interface paths { patch?: never; trace?: never; }; + "/organizations/{org}/settings/billing/usage": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get billing usage report for an organization + * @description Gets a report of the total usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account. + * + * **Note:** This endpoint is only available to organizations with access to the enhanced billing platform. For more information, see "[About the enhanced billing platform](https://docs.github.com/billing/using-the-new-billing-platform)." + */ + get: operations["billing/get-github-billing-usage-report-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/orgs/{org}": { parameters: { query?: never; @@ -3217,13 +3245,11 @@ export interface paths { * Purchases a GitHub Copilot seat for all users within each specified team. * The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." * - * Only organization owners can add Copilot seats for their organization members. - * - * In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy. + * Only organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy. * For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." * For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." * - * The response will contain the total number of new seats that were created and existing seats that were refreshed. + * The response contains the total number of new seats that were created and existing seats that were refreshed. * * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. */ @@ -3235,14 +3261,11 @@ export interface paths { * * Sets seats for all members of each team specified to "pending cancellation". * This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team. - * - * For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." - * - * For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." + * For more information about disabling access to Copilot, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." * * Only organization owners can cancel Copilot seats for their organization members. * - * The response will contain the total number of seats set to "pending cancellation". + * The response contains the total number of seats set to "pending cancellation". * * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. */ @@ -3269,13 +3292,11 @@ export interface paths { * Purchases a GitHub Copilot seat for each user specified. * The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." * - * Only organization owners can add Copilot seats for their organization members. - * - * In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy. + * Only organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy. * For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." * For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." * - * The response will contain the total number of new seats that were created and existing seats that were refreshed. + * The response contains the total number of new seats that were created and existing seats that were refreshed. * * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. */ @@ -3287,14 +3308,11 @@ export interface paths { * * Sets seats for all users specified to "pending cancellation". * This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership. - * - * For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." - * - * For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." + * For more information about disabling access to Copilot, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." * * Only organization owners can cancel Copilot seats for their organization members. * - * The response will contain the total number of seats set to "pending cancellation". + * The response contains the total number of seats set to "pending cancellation". * * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. */ @@ -3609,7 +3627,9 @@ export interface paths { }; /** * List organization webhooks - * @description You must be an organization owner to use this endpoint. + * @description List webhooks for an organization. + * + * The authenticated user must be an organization owner to use this endpoint. * * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. @@ -3654,7 +3674,9 @@ export interface paths { post?: never; /** * Delete an organization webhook - * @description You must be an organization owner to use this endpoint. + * @description Delete a webhook for an organization. + * + * The authenticated user must be an organization owner to use this endpoint. * * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. @@ -5027,6 +5049,109 @@ export interface paths { patch?: never; trace?: never; }; + "/orgs/{org}/private-registries": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List private registries for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Lists all private registry configurations available at the organization-level without revealing their encrypted + * values. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + get: operations["private-registries/list-org-private-registries"]; + put?: never; + /** + * Create a private registry for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Creates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + post: operations["private-registries/create-org-private-registry"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/private-registries/public-key": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get private registries public key for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Gets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets. + * + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + get: operations["private-registries/get-org-public-key"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/private-registries/{secret_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get a private registry for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Get the configuration of a single private registry defined for an organization, omitting its encrypted value. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + get: operations["private-registries/get-org-private-registry"]; + put?: never; + post?: never; + /** + * Delete a private registry for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Delete a private registry configuration at the organization-level. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + delete: operations["private-registries/delete-org-private-registry"]; + options?: never; + head?: never; + /** + * Update a private registry for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + patch: operations["private-registries/update-org-private-registry"]; + trace?: never; + }; "/orgs/{org}/projects": { parameters: { query?: never; @@ -5384,11 +5509,9 @@ export interface paths { }; /** * List security manager teams - * @description Lists teams that are security managers for an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." - * - * The authenticated user must be an administrator or security manager for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the "[Organization Roles](https://docs.github.com/rest/orgs/organization-roles)" endpoints instead. */ get: operations["orgs/list-security-manager-teams"]; put?: never; @@ -5409,21 +5532,17 @@ export interface paths { get?: never; /** * Add a security manager team - * @description Adds a team as a security manager for an organization. For more information, see "[Managing security for an organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) for an organization." - * - * The authenticated user must be an administrator for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the "[Organization Roles](https://docs.github.com/rest/orgs/organization-roles)" endpoints instead. */ put: operations["orgs/add-security-manager-team"]; post?: never; /** * Remove a security manager team - * @description Removes the security manager role from a team for an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) team from an organization." - * - * The authenticated user must be an administrator for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the "[Organization Roles](https://docs.github.com/rest/orgs/organization-roles)" endpoints instead. */ delete: operations["orgs/remove-security-manager-team"]; options?: never; @@ -7166,7 +7285,7 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. * - * This API will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`. + * This endpoint will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`. */ get: operations["actions/list-workflow-runs-for-repo"]; put?: never; @@ -7871,6 +7990,8 @@ export interface paths { * Anyone with read access to the repository can use this endpoint * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * + * This endpoint will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`. */ get: operations["actions/list-workflow-runs"]; put?: never; @@ -8806,6 +8927,62 @@ export interface paths { patch: operations["code-scanning/update-alert"]; trace?: never; }; + "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/autofix": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get the status of an autofix for a code scanning alert + * @description Gets the status and description of an autofix for a code scanning alert. + * + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + */ + get: operations["code-scanning/get-autofix"]; + put?: never; + /** + * Create an autofix for a code scanning alert + * @description Creates an autofix for a code scanning alert. + * + * If a new autofix is to be created as a result of this request or is currently being generated, then this endpoint will return a 202 Accepted response. + * + * If an autofix already exists for a given alert, then this endpoint will return a 200 OK response. + * + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + */ + post: operations["code-scanning/create-autofix"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/autofix/commits": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Commit an autofix for a code scanning alert + * @description Commits an autofix for a code scanning alert. + * + * If an autofix is commited as a result of this request, then this endpoint will return a 201 Created response. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + */ + post: operations["code-scanning/commit-autofix"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances": { parameters: { query?: never; @@ -9700,6 +9877,7 @@ export interface paths { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -9842,6 +10020,7 @@ export interface paths { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -10042,6 +10221,7 @@ export interface paths { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -11026,6 +11206,7 @@ export interface paths { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -11075,6 +11256,7 @@ export interface paths { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -11220,6 +11402,7 @@ export interface paths { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -11265,6 +11448,7 @@ export interface paths { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -11381,7 +11565,12 @@ export interface paths { get: operations["repos/get-webhook"]; put?: never; post?: never; - /** Delete a repository webhook */ + /** + * Delete a repository webhook + * @description Delete a webhook for an organization. + * + * The authenticated user must be a repository owner, or have admin access in the repository, to delete the webhook. + */ delete: operations["repos/delete-webhook"]; options?: never; head?: never; @@ -12288,6 +12477,96 @@ export interface paths { patch?: never; trace?: never; }; + "/repos/{owner}/{repo}/issues/{issue_number}/sub_issue": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + /** + * Remove sub-issue + * @description You can use the REST API to remove a sub-issue from an issue. + * Removing content too quickly using this endpoint may result in secondary rate limiting. + * For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass a specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + */ + delete: operations["issues/remove-sub-issue"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/issues/{issue_number}/sub_issues": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List sub-issues + * @description You can use the REST API to list the sub-issues on an issue. + * + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + */ + get: operations["issues/list-sub-issues"]; + put?: never; + /** + * Add sub-issue + * @description You can use the REST API to add sub-issues to issues. + * + * Creating content too quickly using this endpoint may result in secondary rate limiting. + * For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + * + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + */ + post: operations["issues/add-sub-issue"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/issues/{issue_number}/sub_issues/priority": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + /** + * Reprioritize sub-issue + * @description You can use the REST API to reprioritize a sub-issue to a different position in the parent list. + */ + patch: operations["issues/reprioritize-sub-issue"]; + trace?: never; + }; "/repos/{owner}/{repo}/issues/{issue_number}/timeline": { parameters: { query?: never; @@ -13586,7 +13865,13 @@ export interface paths { }; /** * Get a release asset - * @description To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response. + * @description To download the asset's binary content: + * + * - If within a browser, fetch the location specified in the `browser_download_url` key provided in the response. + * - Alternatively, set the `Accept` header of the request to + * [`application/octet-stream`](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + * The API will either redirect the client to the location, or stream it directly if possible. + * API clients should handle both a `200` or `302` response. */ get: operations["repos/get-release-asset"]; put?: never; @@ -14005,6 +14290,28 @@ export interface paths { patch?: never; trace?: never; }; + "/repos/{owner}/{repo}/secret-scanning/scan-history": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get secret scanning scan history for a repository + * @description Lists the latest incremental and backfill scans by type for a repository. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + */ + get: operations["secret-scanning/get-scan-history"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/repos/{owner}/{repo}/security-advisories": { parameters: { query?: never; @@ -19792,394 +20099,396 @@ export interface components { /** Format: uri */ html_url: string | null; }; - /** - * Organization Simple - * @description A GitHub organization. - */ - "nullable-organization-simple": { - /** @example github */ - login: string; - /** @example 1 */ - id: number; - /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ - node_id: string; + /** @description A code security configuration */ + "code-security-configuration": { + /** @description The ID of the code security configuration */ + id?: number; + /** @description The name of the code security configuration. Must be unique within the organization. */ + name?: string; /** - * Format: uri - * @example https://api.github.com/orgs/github + * @description The type of the code security configuration. + * @enum {string} */ - url: string; + target_type?: "global" | "organization" | "enterprise"; + /** @description A description of the code security configuration */ + description?: string; + /** + * @description The enablement status of GitHub Advanced Security + * @enum {string} + */ + advanced_security?: "enabled" | "disabled"; + /** + * @description The enablement status of Dependency Graph + * @enum {string} + */ + dependency_graph?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Automatic dependency submission + * @enum {string} + */ + dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for Automatic dependency submission */ + dependency_graph_autosubmit_action_options?: { + /** @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. */ + labeled_runners?: boolean; + }; + /** + * @description The enablement status of Dependabot alerts + * @enum {string} + */ + dependabot_alerts?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot security updates + * @enum {string} + */ + dependabot_security_updates?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of code scanning default setup + * @enum {string} + */ + code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for code scanning default setup */ + code_scanning_default_setup_options?: { + /** + * @description Whether to use labeled runners or standard GitHub runners. + * @enum {string|null} + */ + runner_type?: "standard" | "labeled" | "not_set" | null; + /** @description The label of the runner to use for code scanning when runner_type is 'labeled'. */ + runner_label?: string | null; + } | null; + /** + * @description The enablement status of secret scanning + * @enum {string} + */ + secret_scanning?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning push protection + * @enum {string} + */ + secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning delegated bypass + * @enum {string} + */ + secret_scanning_delegated_bypass?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for secret scanning delegated bypass */ + secret_scanning_delegated_bypass_options?: { + /** @description The bypass reviewers for secret scanning delegated bypass */ + reviewers?: { + /** @description The ID of the team or role selected as a bypass reviewer */ + reviewer_id: number; + /** + * @description The type of the bypass reviewer + * @enum {string} + */ + reviewer_type: "TEAM" | "ROLE"; + }[]; + }; + /** + * @description The enablement status of secret scanning validity checks + * @enum {string} + */ + secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning non-provider patterns + * @enum {string} + */ + secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of private vulnerability reporting + * @enum {string} + */ + private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; + /** + * @description The enforcement status for a security configuration + * @enum {string} + */ + enforcement?: "enforced" | "unenforced"; /** * Format: uri - * @example https://api.github.com/orgs/github/repos + * @description The URL of the configuration */ - repos_url: string; + url?: string; /** * Format: uri - * @example https://api.github.com/orgs/github/events + * @description The URL of the configuration */ - events_url: string; - /** @example https://api.github.com/orgs/github/hooks */ - hooks_url: string; - /** @example https://api.github.com/orgs/github/issues */ - issues_url: string; - /** @example https://api.github.com/orgs/github/members{/member} */ - members_url: string; - /** @example https://api.github.com/orgs/github/public_members{/member} */ - public_members_url: string; - /** @example https://github.com/images/error/octocat_happy.gif */ - avatar_url: string; - /** @example A great organization */ - description: string | null; + html_url?: string; + /** Format: date-time */ + created_at?: string; + /** Format: date-time */ + updated_at?: string; + }; + /** @description Feature options for code scanning default setup */ + "code-scanning-default-setup-options": { + /** + * @description Whether to use labeled runners or standard GitHub runners. + * @enum {string} + */ + runner_type?: "standard" | "labeled" | "not_set"; + /** @description The label of the runner to use for code scanning default setup when runner_type is 'labeled'. */ + runner_label?: string | null; } | null; + /** @description A list of default code security configurations */ + "code-security-default-configurations": { + /** + * @description The visibility of newly created repositories for which the code security configuration will be applied to by default + * @enum {unknown} + */ + default_for_new_repos?: "public" | "private_and_internal" | "all"; + configuration?: components["schemas"]["code-security-configuration"]; + }[]; /** - * Team Simple - * @description Groups of organization members that gives permissions on specified repositories. + * Simple Repository + * @description A GitHub repository. */ - "nullable-team-simple": { + "simple-repository": { /** - * @description Unique identifier of the team - * @example 1 + * Format: int64 + * @description A unique identifier of the repository. + * @example 1296269 */ id: number; - /** @example MDQ6VGVhbTE= */ + /** + * @description The GraphQL identifier of the repository. + * @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + */ node_id: string; + /** + * @description The name of the repository. + * @example Hello-World + */ + name: string; + /** + * @description The full, globally unique, name of the repository. + * @example octocat/Hello-World + */ + full_name: string; + owner: components["schemas"]["simple-user"]; + /** @description Whether the repository is private. */ + private: boolean; /** * Format: uri - * @description URL for the team - * @example https://api.github.com/organizations/1/team/1 + * @description The URL to view the repository on GitHub.com. + * @example https://github.com/octocat/Hello-World + */ + html_url: string; + /** + * @description The repository description. + * @example This your first repo! + */ + description: string | null; + /** @description Whether the repository is a fork. */ + fork: boolean; + /** + * Format: uri + * @description The URL to get more information about the repository from the GitHub API. + * @example https://api.github.com/repos/octocat/Hello-World */ url: string; - /** @example https://api.github.com/organizations/1/team/1/members{/member} */ - members_url: string; /** - * @description Name of the team - * @example Justice League + * @description A template for the API URL to download the repository as an archive. + * @example https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ - name: string; + archive_url: string; /** - * @description Description of the team - * @example A great team. + * @description A template for the API URL to list the available assignees for issues in the repository. + * @example https://api.github.com/repos/octocat/Hello-World/assignees{/user} */ - description: string | null; + assignees_url: string; /** - * @description Permission that the team will have for its repositories - * @example admin + * @description A template for the API URL to create or retrieve a raw Git blob in the repository. + * @example https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} */ - permission: string; + blobs_url: string; /** - * @description The level of privacy this team should have - * @example closed + * @description A template for the API URL to get information about branches in the repository. + * @example https://api.github.com/repos/octocat/Hello-World/branches{/branch} */ - privacy?: string; + branches_url: string; /** - * @description The notification setting the team has set - * @example notifications_enabled + * @description A template for the API URL to get information about collaborators of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} */ - notification_setting?: string; + collaborators_url: string; + /** + * @description A template for the API URL to get information about comments on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/comments{/number} + */ + comments_url: string; + /** + * @description A template for the API URL to get information about commits on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/commits{/sha} + */ + commits_url: string; + /** + * @description A template for the API URL to compare two commits or refs. + * @example https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + */ + compare_url: string; + /** + * @description A template for the API URL to get the contents of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/contents/{+path} + */ + contents_url: string; /** * Format: uri - * @example https://github.com/orgs/rails/teams/core + * @description A template for the API URL to list the contributors to the repository. + * @example https://api.github.com/repos/octocat/Hello-World/contributors */ - html_url: string; + contributors_url: string; /** * Format: uri - * @example https://api.github.com/organizations/1/team/1/repos + * @description The API URL to list the deployments of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/deployments */ - repositories_url: string; - /** @example justice-league */ - slug: string; + deployments_url: string; /** - * @description Distinguished Name (DN) that team maps to within LDAP environment - * @example uid=example,ou=users,dc=github,dc=com + * Format: uri + * @description The API URL to list the downloads on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/downloads */ - ldap_dn?: string; - } | null; - /** - * Team - * @description Groups of organization members that gives permissions on specified repositories. - */ - team: { - id: number; - node_id: string; - name: string; - slug: string; - description: string | null; - privacy?: string; - notification_setting?: string; - permission: string; - permissions?: { - pull: boolean; - triage: boolean; - push: boolean; - maintain: boolean; - admin: boolean; - }; - /** Format: uri */ - url: string; + downloads_url: string; /** * Format: uri - * @example https://github.com/orgs/rails/teams/core + * @description The API URL to list the events of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/events */ - html_url: string; - members_url: string; - /** Format: uri */ - repositories_url: string; - parent: components["schemas"]["nullable-team-simple"]; - }; - /** - * Enterprise Team - * @description Group of enterprise owners and/or members - */ - "enterprise-team": { - /** Format: int64 */ - id: number; - name: string; - slug: string; - /** Format: uri */ - url: string; - /** @example disabled | all */ - sync_to_organizations: string; - /** @example 62ab9291-fae2-468e-974b-7e45096d5021 */ - group_id?: string | null; + events_url: string; /** * Format: uri - * @example https://github.com/enterprises/dc/teams/justice-league + * @description The API URL to list the forks of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/forks */ - html_url: string; - members_url: string; - /** Format: date-time */ - created_at: string; - /** Format: date-time */ - updated_at: string; - }; - /** - * Copilot Business Seat Detail - * @description Information about a Copilot Business seat assignment for a user, team, or organization. - */ - "copilot-seat-details": { - assignee: components["schemas"]["simple-user"]; - organization?: components["schemas"]["nullable-organization-simple"]; - /** @description The team through which the assignee is granted access to GitHub Copilot, if applicable. */ - assigning_team?: (components["schemas"]["team"] | components["schemas"]["enterprise-team"]) | null; + forks_url: string; /** - * Format: date - * @description The pending cancellation date for the seat, in `YYYY-MM-DD` format. This will be null unless the assignee's Copilot access has been canceled during the current billing cycle. If the seat has been cancelled, this corresponds to the start of the organization's next billing cycle. + * @description A template for the API URL to get information about Git commits of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ - pending_cancellation_date?: string | null; + git_commits_url: string; /** - * Format: date-time - * @description Timestamp of user's last GitHub Copilot activity, in ISO 8601 format. + * @description A template for the API URL to get information about Git refs of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} */ - last_activity_at?: string | null; - /** @description Last editor that was used by the user for a GitHub Copilot completion. */ - last_activity_editor?: string | null; + git_refs_url: string; /** - * Format: date-time - * @description Timestamp of when the assignee was last granted access to GitHub Copilot, in ISO 8601 format. + * @description A template for the API URL to get information about Git tags of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} */ - created_at: string; + git_tags_url: string; /** - * Format: date-time - * @description Timestamp of when the assignee's GitHub Copilot access was last updated, in ISO 8601 format. + * @description A template for the API URL to get information about issue comments on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} */ - updated_at?: string; + issue_comment_url: string; /** - * @description The Copilot plan of the organization, or the parent enterprise, when applicable. - * @enum {string} + * @description A template for the API URL to get information about issue events on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/issues/events{/number} */ - plan_type?: "business" | "enterprise" | "unknown"; - }; - /** @description Usage metrics for Copilot editor code completions in the IDE. */ - "copilot-ide-code-completions": ({ - /** @description Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances. */ - total_engaged_users?: number; - /** @description Code completion metrics for active languages. */ - languages?: { - /** @description Name of the language used for Copilot code completion suggestions. */ - name?: string; - /** @description Number of users who accepted at least one Copilot code completion suggestion for the given language. Includes both full and partial acceptances. */ - total_engaged_users?: number; - }[]; - editors?: ({ - /** @description Name of the given editor. */ - name?: string; - /** @description Number of users who accepted at least one Copilot code completion suggestion for the given editor. Includes both full and partial acceptances. */ - total_engaged_users?: number; - /** @description List of model metrics for custom models and the default model. */ - models?: { - /** @description Name of the language used for Copilot code completion suggestions, for the given editor. */ - name?: string; - /** @description Indicates whether a model is custom or default. */ - is_custom_model?: boolean; - /** @description The training date for the custom model. */ - custom_model_training_date?: string | null; - /** @description Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances. */ - total_engaged_users?: number; - /** @description Code completion metrics for active languages, for the given editor. */ - languages?: { - /** @description Name of the language used for Copilot code completion suggestions, for the given editor. */ - name?: string; - /** @description Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language. Includes both full and partial acceptances. */ - total_engaged_users?: number; - /** @description The number of Copilot code suggestions generated for the given editor, for the given language. */ - total_code_suggestions?: number; - /** @description The number of Copilot code suggestions accepted for the given editor, for the given language. Includes both full and partial acceptances. */ - total_code_acceptances?: number; - /** @description The number of lines of code suggested by Copilot code completions for the given editor, for the given language. */ - total_code_lines_suggested?: number; - /** @description The number of lines of code accepted from Copilot code suggestions for the given editor, for the given language. */ - total_code_lines_accepted?: number; - }[]; - }[]; - } & { - [key: string]: unknown; - })[]; - } & { - [key: string]: unknown; - }) | null; - /** @description Usage metrics for Copilot Chat in the IDE. */ - "copilot-ide-chat": ({ - /** @description Total number of users who prompted Copilot Chat in the IDE. */ - total_engaged_users?: number; - editors?: { - /** @description Name of the given editor. */ - name?: string; - /** @description The number of users who prompted Copilot Chat in the specified editor. */ - total_engaged_users?: number; - /** @description List of model metrics for custom models and the default model. */ - models?: { - /** @description Name of the language used for Copilot code completion suggestions, for the given editor. */ - name?: string; - /** @description Indicates whether a model is custom or default. */ - is_custom_model?: boolean; - /** @description The training date for the custom model. */ - custom_model_training_date?: string | null; - /** @description The number of users who prompted Copilot Chat in the given editor and model. */ - total_engaged_users?: number; - /** @description The total number of chats initiated by users in the given editor and model. */ - total_chats?: number; - /** @description The number of times users accepted a code suggestion from Copilot Chat using the 'Insert Code' UI element, for the given editor. */ - total_chat_insertion_events?: number; - /** @description The number of times users copied a code suggestion from Copilot Chat using the keyboard, or the 'Copy' UI element, for the given editor. */ - total_chat_copy_events?: number; - }[]; - }[]; - } & { - [key: string]: unknown; - }) | null; - /** @description Usage metrics for Copilot Chat in github.com */ - "copilot-dotcom-chat": ({ - /** @description Total number of users who prompted Copilot Chat on github.com at least once. */ - total_engaged_users?: number; - /** @description List of model metrics for a custom models and the default model. */ - models?: { - /** @description Name of the language used for Copilot code completion suggestions, for the given editor. */ - name?: string; - /** @description Indicates whether a model is custom or default. */ - is_custom_model?: boolean; - /** @description The training date for the custom model (if applicable). */ - custom_model_training_date?: string | null; - /** @description Total number of users who prompted Copilot Chat on github.com at least once for each model. */ - total_engaged_users?: number; - /** @description Total number of chats initiated by users on github.com. */ - total_chats?: number; - }[]; - } & { - [key: string]: unknown; - }) | null; - /** @description Usage metrics for Copilot for pull requests. */ - "copilot-dotcom-pull-requests": ({ - /** @description The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once. */ - total_engaged_users?: number; - /** @description Repositories in which users used Copilot for Pull Requests to generate pull request summaries */ - repositories?: { - /** @description Repository name */ - name?: string; - /** @description The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository. */ - total_engaged_users?: number; - /** @description List of model metrics for custom models and the default model. */ - models?: { - /** @description Name of the language used for Copilot code completion suggestions, for the given editor. */ - name?: string; - /** @description Indicates whether a model is custom or default. */ - is_custom_model?: boolean; - /** @description The training date for the custom model. */ - custom_model_training_date?: string | null; - /** @description The number of pull request summaries generated using Copilot for Pull Requests in the given repository. */ - total_pr_summaries_created?: number; - /** @description The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository and model. */ - total_engaged_users?: number; - }[]; - }[]; - } & { - [key: string]: unknown; - }) | null; - /** - * Copilot Usage Metrics - * @description Copilot usage metrics for a given day. - */ - "copilot-usage-metrics-day": { + issue_events_url: string; /** - * Format: date - * @description The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format. + * @description A template for the API URL to get information about issues on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/issues{/number} */ - date: string; - /** @description The total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint. */ - total_active_users?: number; - /** @description The total number of Copilot users who engaged with any Copilot feature, for the given day. Examples include but are not limited to accepting a code suggestion, prompting Copilot chat, or triggering a PR Summary. Does not include authentication events. Is not limited to the individual features detailed on the endpoint. */ - total_engaged_users?: number; - copilot_ide_code_completions?: components["schemas"]["copilot-ide-code-completions"]; - copilot_ide_chat?: components["schemas"]["copilot-ide-chat"]; - copilot_dotcom_chat?: components["schemas"]["copilot-dotcom-chat"]; - copilot_dotcom_pull_requests?: components["schemas"]["copilot-dotcom-pull-requests"]; - } & { - [key: string]: unknown; + issues_url: string; + /** + * @description A template for the API URL to get information about deploy keys on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + */ + keys_url: string; + /** + * @description A template for the API URL to get information about labels of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/labels{/name} + */ + labels_url: string; + /** + * Format: uri + * @description The API URL to get information about the languages of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/languages + */ + languages_url: string; + /** + * Format: uri + * @description The API URL to merge branches in the repository. + * @example https://api.github.com/repos/octocat/Hello-World/merges + */ + merges_url: string; + /** + * @description A template for the API URL to get information about milestones of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/milestones{/number} + */ + milestones_url: string; + /** + * @description A template for the API URL to get information about notifications on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + */ + notifications_url: string; + /** + * @description A template for the API URL to get information about pull requests on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/pulls{/number} + */ + pulls_url: string; + /** + * @description A template for the API URL to get information about releases on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/releases{/id} + */ + releases_url: string; + /** + * Format: uri + * @description The API URL to list the stargazers on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/stargazers + */ + stargazers_url: string; + /** + * @description A template for the API URL to get information about statuses of a commit. + * @example https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + */ + statuses_url: string; + /** + * Format: uri + * @description The API URL to list the subscribers on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/subscribers + */ + subscribers_url: string; + /** + * Format: uri + * @description The API URL to subscribe to notifications for this repository. + * @example https://api.github.com/repos/octocat/Hello-World/subscription + */ + subscription_url: string; + /** + * Format: uri + * @description The API URL to get information about tags on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/tags + */ + tags_url: string; + /** + * Format: uri + * @description The API URL to list the teams on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/teams + */ + teams_url: string; + /** + * @description A template for the API URL to create or retrieve a raw Git tree of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + */ + trees_url: string; + /** + * Format: uri + * @description The API URL to list the hooks on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/hooks + */ + hooks_url: string; }; - /** - * Copilot Usage Metrics - * @description Summary of Copilot usage. - */ - "copilot-usage-metrics": { + /** @description Repositories associated with a code security configuration and attachment status */ + "code-security-configuration-repositories": { /** - * Format: date - * @description The date for which the usage metrics are reported, in `YYYY-MM-DD` format. + * @description The attachment status of the code security configuration on the repository. + * @enum {string} */ - day: string; - /** @description The total number of Copilot code completion suggestions shown to users. */ - total_suggestions_count?: number; - /** @description The total number of Copilot code completion suggestions accepted by users. */ - total_acceptances_count?: number; - /** @description The total number of lines of code completions suggested by Copilot. */ - total_lines_suggested?: number; - /** @description The total number of lines of code completions accepted by users. */ - total_lines_accepted?: number; - /** @description The total number of users who were shown Copilot code completion suggestions during the day specified. */ - total_active_users?: number; - /** @description The total instances of users who accepted code suggested by Copilot Chat in the IDE (panel and inline). */ - total_chat_acceptances?: number; - /** @description The total number of chat turns (prompt and response pairs) sent between users and Copilot Chat in the IDE. */ - total_chat_turns?: number; - /** @description The total number of users who interacted with Copilot Chat in the IDE during the day specified. */ - total_active_chat_users?: number; - /** @description Breakdown of Copilot code completions usage by language and editor */ - breakdown: ({ - /** @description The language in which Copilot suggestions were shown to users in the specified editor. */ - language?: string; - /** @description The editor in which Copilot suggestions were shown to users for the specified language. */ - editor?: string; - /** @description The number of Copilot suggestions shown to users in the editor specified during the day specified. */ - suggestions_count?: number; - /** @description The number of Copilot suggestions accepted by users in the editor specified during the day specified. */ - acceptances_count?: number; - /** @description The number of lines of code suggested by Copilot in the editor specified during the day specified. */ - lines_suggested?: number; - /** @description The number of lines of code accepted by users in the editor specified during the day specified. */ - lines_accepted?: number; - /** @description The number of users who were shown Copilot completion suggestions in the editor specified during the day specified. */ - active_users?: number; - } & { - [key: string]: unknown; - })[] | null; + status?: "attached" | "attaching" | "detached" | "removed" | "enforced" | "failed" | "updating" | "removed_by_enterprise"; + repository?: components["schemas"]["simple-repository"]; }; /** @description The security alert number. */ "alert-number": number; @@ -20307,248 +20616,6 @@ export interface components { * @description The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ "alert-auto-dismissed-at": string | null; - /** - * Simple Repository - * @description A GitHub repository. - */ - "simple-repository": { - /** - * Format: int64 - * @description A unique identifier of the repository. - * @example 1296269 - */ - id: number; - /** - * @description The GraphQL identifier of the repository. - * @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - */ - node_id: string; - /** - * @description The name of the repository. - * @example Hello-World - */ - name: string; - /** - * @description The full, globally unique, name of the repository. - * @example octocat/Hello-World - */ - full_name: string; - owner: components["schemas"]["simple-user"]; - /** @description Whether the repository is private. */ - private: boolean; - /** - * Format: uri - * @description The URL to view the repository on GitHub.com. - * @example https://github.com/octocat/Hello-World - */ - html_url: string; - /** - * @description The repository description. - * @example This your first repo! - */ - description: string | null; - /** @description Whether the repository is a fork. */ - fork: boolean; - /** - * Format: uri - * @description The URL to get more information about the repository from the GitHub API. - * @example https://api.github.com/repos/octocat/Hello-World - */ - url: string; - /** - * @description A template for the API URL to download the repository as an archive. - * @example https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - */ - archive_url: string; - /** - * @description A template for the API URL to list the available assignees for issues in the repository. - * @example https://api.github.com/repos/octocat/Hello-World/assignees{/user} - */ - assignees_url: string; - /** - * @description A template for the API URL to create or retrieve a raw Git blob in the repository. - * @example https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - */ - blobs_url: string; - /** - * @description A template for the API URL to get information about branches in the repository. - * @example https://api.github.com/repos/octocat/Hello-World/branches{/branch} - */ - branches_url: string; - /** - * @description A template for the API URL to get information about collaborators of the repository. - * @example https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - */ - collaborators_url: string; - /** - * @description A template for the API URL to get information about comments on the repository. - * @example https://api.github.com/repos/octocat/Hello-World/comments{/number} - */ - comments_url: string; - /** - * @description A template for the API URL to get information about commits on the repository. - * @example https://api.github.com/repos/octocat/Hello-World/commits{/sha} - */ - commits_url: string; - /** - * @description A template for the API URL to compare two commits or refs. - * @example https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - */ - compare_url: string; - /** - * @description A template for the API URL to get the contents of the repository. - * @example https://api.github.com/repos/octocat/Hello-World/contents/{+path} - */ - contents_url: string; - /** - * Format: uri - * @description A template for the API URL to list the contributors to the repository. - * @example https://api.github.com/repos/octocat/Hello-World/contributors - */ - contributors_url: string; - /** - * Format: uri - * @description The API URL to list the deployments of the repository. - * @example https://api.github.com/repos/octocat/Hello-World/deployments - */ - deployments_url: string; - /** - * Format: uri - * @description The API URL to list the downloads on the repository. - * @example https://api.github.com/repos/octocat/Hello-World/downloads - */ - downloads_url: string; - /** - * Format: uri - * @description The API URL to list the events of the repository. - * @example https://api.github.com/repos/octocat/Hello-World/events - */ - events_url: string; - /** - * Format: uri - * @description The API URL to list the forks of the repository. - * @example https://api.github.com/repos/octocat/Hello-World/forks - */ - forks_url: string; - /** - * @description A template for the API URL to get information about Git commits of the repository. - * @example https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - */ - git_commits_url: string; - /** - * @description A template for the API URL to get information about Git refs of the repository. - * @example https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - */ - git_refs_url: string; - /** - * @description A template for the API URL to get information about Git tags of the repository. - * @example https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - */ - git_tags_url: string; - /** - * @description A template for the API URL to get information about issue comments on the repository. - * @example https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - */ - issue_comment_url: string; - /** - * @description A template for the API URL to get information about issue events on the repository. - * @example https://api.github.com/repos/octocat/Hello-World/issues/events{/number} - */ - issue_events_url: string; - /** - * @description A template for the API URL to get information about issues on the repository. - * @example https://api.github.com/repos/octocat/Hello-World/issues{/number} - */ - issues_url: string; - /** - * @description A template for the API URL to get information about deploy keys on the repository. - * @example https://api.github.com/repos/octocat/Hello-World/keys{/key_id} - */ - keys_url: string; - /** - * @description A template for the API URL to get information about labels of the repository. - * @example https://api.github.com/repos/octocat/Hello-World/labels{/name} - */ - labels_url: string; - /** - * Format: uri - * @description The API URL to get information about the languages of the repository. - * @example https://api.github.com/repos/octocat/Hello-World/languages - */ - languages_url: string; - /** - * Format: uri - * @description The API URL to merge branches in the repository. - * @example https://api.github.com/repos/octocat/Hello-World/merges - */ - merges_url: string; - /** - * @description A template for the API URL to get information about milestones of the repository. - * @example https://api.github.com/repos/octocat/Hello-World/milestones{/number} - */ - milestones_url: string; - /** - * @description A template for the API URL to get information about notifications on the repository. - * @example https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - */ - notifications_url: string; - /** - * @description A template for the API URL to get information about pull requests on the repository. - * @example https://api.github.com/repos/octocat/Hello-World/pulls{/number} - */ - pulls_url: string; - /** - * @description A template for the API URL to get information about releases on the repository. - * @example https://api.github.com/repos/octocat/Hello-World/releases{/id} - */ - releases_url: string; - /** - * Format: uri - * @description The API URL to list the stargazers on the repository. - * @example https://api.github.com/repos/octocat/Hello-World/stargazers - */ - stargazers_url: string; - /** - * @description A template for the API URL to get information about statuses of a commit. - * @example https://api.github.com/repos/octocat/Hello-World/statuses/{sha} - */ - statuses_url: string; - /** - * Format: uri - * @description The API URL to list the subscribers on the repository. - * @example https://api.github.com/repos/octocat/Hello-World/subscribers - */ - subscribers_url: string; - /** - * Format: uri - * @description The API URL to subscribe to notifications for this repository. - * @example https://api.github.com/repos/octocat/Hello-World/subscription - */ - subscription_url: string; - /** - * Format: uri - * @description The API URL to get information about tags on the repository. - * @example https://api.github.com/repos/octocat/Hello-World/tags - */ - tags_url: string; - /** - * Format: uri - * @description The API URL to list the teams on the repository. - * @example https://api.github.com/repos/octocat/Hello-World/teams - */ - teams_url: string; - /** - * @description A template for the API URL to create or retrieve a raw Git tree of the repository. - * @example https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - */ - trees_url: string; - /** - * Format: uri - * @description The API URL to list the hooks on the repository. - * @example https://api.github.com/repos/octocat/Hello-World/hooks - */ - hooks_url: string; - }; /** @description A Dependabot alert. */ "dependabot-alert-with-repository": { number: components["schemas"]["alert-number"]; @@ -20637,6 +20704,16 @@ export interface components { * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ push_protection_bypassed_at?: string | null; + push_protection_bypass_request_reviewer?: components["schemas"]["nullable-simple-user"]; + /** @description An optional comment when reviewing a push protection bypass. */ + push_protection_bypass_request_reviewer_comment?: string | null; + /** @description An optional comment when requesting a push protection bypass. */ + push_protection_bypass_request_comment?: string | null; + /** + * Format: uri + * @description The URL to a push protection bypass request. + */ + push_protection_bypass_request_html_url?: string | null; /** @description The comment that was optionally added when this alert was closed */ resolution_comment?: string | null; /** @@ -20836,6 +20913,12 @@ export interface components { eyes: number; rocket: number; }; + /** Sub-issues Summary */ + "sub-issues-summary": { + total: number; + completed: number; + percent_completed: number; + }; /** * Issue * @description Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. @@ -20938,6 +21021,7 @@ export interface components { performed_via_github_app?: components["schemas"]["nullable-integration"]; author_association: components["schemas"]["author-association"]; reactions?: components["schemas"]["reaction-rollup"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; }; /** * Issue Comment @@ -21624,6 +21708,10 @@ export interface components { copilot?: string[]; packages?: string[]; actions?: string[]; + actions_inbound?: { + full_domains?: string[]; + wildcard_domains?: string[]; + }; artifact_attestations?: { /** @example [ * "example" @@ -21967,6 +22055,32 @@ export interface components { /** @example A great organization */ description: string | null; }; + "billing-usage-report": { + usageItems?: { + /** @description Date of the usage line item. */ + date: string; + /** @description Product name. */ + product: string; + /** @description SKU name. */ + sku: string; + /** @description Quantity of the usage line item. */ + quantity: number; + /** @description Unit type of the usage line item. */ + unitType: string; + /** @description Price per unit of the usage line item. */ + pricePerUnit: number; + /** @description Gross amount of the usage line item. */ + grossAmount: number; + /** @description Discount amount of the usage line item. */ + discountAmount: number; + /** @description Net amount of the usage line item. */ + netAmount: number; + /** @description Name of the organization. */ + organizationName: string; + /** @description Name of the repository. */ + repositoryName?: string; + }[]; + }; /** * Organization Full * @description Organization Full @@ -22588,135 +22702,6 @@ export interface components { most_recent_instance: components["schemas"]["code-scanning-alert-instance"]; repository: components["schemas"]["simple-repository"]; }; - /** @description A code security configuration */ - "code-security-configuration": { - /** @description The ID of the code security configuration */ - id?: number; - /** @description The name of the code security configuration. Must be unique within the organization. */ - name?: string; - /** - * @description The type of the code security configuration. - * @enum {string} - */ - target_type?: "global" | "organization" | "enterprise"; - /** @description A description of the code security configuration */ - description?: string; - /** - * @description The enablement status of GitHub Advanced Security - * @enum {string} - */ - advanced_security?: "enabled" | "disabled"; - /** - * @description The enablement status of Dependency Graph - * @enum {string} - */ - dependency_graph?: "enabled" | "disabled" | "not_set"; - /** - * @description The enablement status of Automatic dependency submission - * @enum {string} - */ - dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"; - /** @description Feature options for Automatic dependency submission */ - dependency_graph_autosubmit_action_options?: { - /** @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. */ - labeled_runners?: boolean; - }; - /** - * @description The enablement status of Dependabot alerts - * @enum {string} - */ - dependabot_alerts?: "enabled" | "disabled" | "not_set"; - /** - * @description The enablement status of Dependabot security updates - * @enum {string} - */ - dependabot_security_updates?: "enabled" | "disabled" | "not_set"; - /** - * @description The enablement status of code scanning default setup - * @enum {string} - */ - code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; - /** - * @description The enablement status of secret scanning - * @enum {string} - */ - secret_scanning?: "enabled" | "disabled" | "not_set"; - /** - * @description The enablement status of secret scanning push protection - * @enum {string} - */ - secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; - /** - * @description The enablement status of secret scanning delegated bypass - * @enum {string} - */ - secret_scanning_delegated_bypass?: "enabled" | "disabled" | "not_set"; - /** @description Feature options for secret scanning delegated bypass */ - secret_scanning_delegated_bypass_options?: { - /** @description The bypass reviewers for secret scanning delegated bypass */ - reviewers?: { - /** @description The ID of the team or role selected as a bypass reviewer */ - reviewer_id: number; - /** - * @description The type of the bypass reviewer - * @enum {string} - */ - reviewer_type: "TEAM" | "ROLE"; - }[]; - }; - /** - * @description The enablement status of secret scanning validity checks - * @enum {string} - */ - secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; - /** - * @description The enablement status of secret scanning non-provider patterns - * @enum {string} - */ - secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set"; - /** - * @description The enablement status of private vulnerability reporting - * @enum {string} - */ - private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; - /** - * @description The enforcement status for a security configuration - * @enum {string} - */ - enforcement?: "enforced" | "unenforced"; - /** - * Format: uri - * @description The URL of the configuration - */ - url?: string; - /** - * Format: uri - * @description The URL of the configuration - */ - html_url?: string; - /** Format: date-time */ - created_at?: string; - /** Format: date-time */ - updated_at?: string; - }; - /** @description A list of default code security configurations */ - "code-security-default-configurations": { - /** - * @description The visibility of newly created repositories for which the code security configuration will be applied to by default - * @enum {unknown} - */ - default_for_new_repos?: "public" | "private_and_internal" | "all"; - configuration?: components["schemas"]["code-security-configuration"]; - }[]; - /** @description Repositories associated with a code security configuration and attachment status */ - "code-security-configuration-repositories": { - /** - * @description The attachment status of the code security configuration on the repository. - * @enum {string} - */ - status?: "attached" | "attaching" | "detached" | "removed" | "enforced" | "failed" | "updating" | "removed_by_enterprise"; - repository?: components["schemas"]["simple-repository"]; - }; /** * Codespace machine * @description A description of the machine powering a codespace. @@ -23029,6 +23014,396 @@ export interface components { } & { [key: string]: unknown; }; + /** + * Organization Simple + * @description A GitHub organization. + */ + "nullable-organization-simple": { + /** @example github */ + login: string; + /** @example 1 */ + id: number; + /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ + node_id: string; + /** + * Format: uri + * @example https://api.github.com/orgs/github + */ + url: string; + /** + * Format: uri + * @example https://api.github.com/orgs/github/repos + */ + repos_url: string; + /** + * Format: uri + * @example https://api.github.com/orgs/github/events + */ + events_url: string; + /** @example https://api.github.com/orgs/github/hooks */ + hooks_url: string; + /** @example https://api.github.com/orgs/github/issues */ + issues_url: string; + /** @example https://api.github.com/orgs/github/members{/member} */ + members_url: string; + /** @example https://api.github.com/orgs/github/public_members{/member} */ + public_members_url: string; + /** @example https://github.com/images/error/octocat_happy.gif */ + avatar_url: string; + /** @example A great organization */ + description: string | null; + } | null; + /** + * Team Simple + * @description Groups of organization members that gives permissions on specified repositories. + */ + "nullable-team-simple": { + /** + * @description Unique identifier of the team + * @example 1 + */ + id: number; + /** @example MDQ6VGVhbTE= */ + node_id: string; + /** + * Format: uri + * @description URL for the team + * @example https://api.github.com/organizations/1/team/1 + */ + url: string; + /** @example https://api.github.com/organizations/1/team/1/members{/member} */ + members_url: string; + /** + * @description Name of the team + * @example Justice League + */ + name: string; + /** + * @description Description of the team + * @example A great team. + */ + description: string | null; + /** + * @description Permission that the team will have for its repositories + * @example admin + */ + permission: string; + /** + * @description The level of privacy this team should have + * @example closed + */ + privacy?: string; + /** + * @description The notification setting the team has set + * @example notifications_enabled + */ + notification_setting?: string; + /** + * Format: uri + * @example https://github.com/orgs/rails/teams/core + */ + html_url: string; + /** + * Format: uri + * @example https://api.github.com/organizations/1/team/1/repos + */ + repositories_url: string; + /** @example justice-league */ + slug: string; + /** + * @description Distinguished Name (DN) that team maps to within LDAP environment + * @example uid=example,ou=users,dc=github,dc=com + */ + ldap_dn?: string; + } | null; + /** + * Team + * @description Groups of organization members that gives permissions on specified repositories. + */ + team: { + id: number; + node_id: string; + name: string; + slug: string; + description: string | null; + privacy?: string; + notification_setting?: string; + permission: string; + permissions?: { + pull: boolean; + triage: boolean; + push: boolean; + maintain: boolean; + admin: boolean; + }; + /** Format: uri */ + url: string; + /** + * Format: uri + * @example https://github.com/orgs/rails/teams/core + */ + html_url: string; + members_url: string; + /** Format: uri */ + repositories_url: string; + parent: components["schemas"]["nullable-team-simple"]; + }; + /** + * Enterprise Team + * @description Group of enterprise owners and/or members + */ + "enterprise-team": { + /** Format: int64 */ + id: number; + name: string; + slug: string; + /** Format: uri */ + url: string; + /** @example disabled | all */ + sync_to_organizations: string; + /** @example 62ab9291-fae2-468e-974b-7e45096d5021 */ + group_id?: string | null; + /** + * Format: uri + * @example https://github.com/enterprises/dc/teams/justice-league + */ + html_url: string; + members_url: string; + /** Format: date-time */ + created_at: string; + /** Format: date-time */ + updated_at: string; + }; + /** + * Copilot Business Seat Detail + * @description Information about a Copilot Business seat assignment for a user, team, or organization. + */ + "copilot-seat-details": { + assignee: components["schemas"]["simple-user"]; + organization?: components["schemas"]["nullable-organization-simple"]; + /** @description The team through which the assignee is granted access to GitHub Copilot, if applicable. */ + assigning_team?: (components["schemas"]["team"] | components["schemas"]["enterprise-team"]) | null; + /** + * Format: date + * @description The pending cancellation date for the seat, in `YYYY-MM-DD` format. This will be null unless the assignee's Copilot access has been canceled during the current billing cycle. If the seat has been cancelled, this corresponds to the start of the organization's next billing cycle. + */ + pending_cancellation_date?: string | null; + /** + * Format: date-time + * @description Timestamp of user's last GitHub Copilot activity, in ISO 8601 format. + */ + last_activity_at?: string | null; + /** @description Last editor that was used by the user for a GitHub Copilot completion. */ + last_activity_editor?: string | null; + /** + * Format: date-time + * @description Timestamp of when the assignee was last granted access to GitHub Copilot, in ISO 8601 format. + */ + created_at: string; + /** + * Format: date-time + * @deprecated + * @description **Closing down notice:** This field is no longer relevant and is closing down. Use the `created_at` field to determine when the assignee was last granted access to GitHub Copilot. Timestamp of when the assignee's GitHub Copilot access was last updated, in ISO 8601 format. + */ + updated_at?: string; + /** + * @description The Copilot plan of the organization, or the parent enterprise, when applicable. + * @enum {string} + */ + plan_type?: "business" | "enterprise" | "unknown"; + }; + /** @description Usage metrics for Copilot editor code completions in the IDE. */ + "copilot-ide-code-completions": ({ + /** @description Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances. */ + total_engaged_users?: number; + /** @description Code completion metrics for active languages. */ + languages?: { + /** @description Name of the language used for Copilot code completion suggestions. */ + name?: string; + /** @description Number of users who accepted at least one Copilot code completion suggestion for the given language. Includes both full and partial acceptances. */ + total_engaged_users?: number; + }[]; + editors?: ({ + /** @description Name of the given editor. */ + name?: string; + /** @description Number of users who accepted at least one Copilot code completion suggestion for the given editor. Includes both full and partial acceptances. */ + total_engaged_users?: number; + /** @description List of model metrics for custom models and the default model. */ + models?: { + /** @description Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'. */ + name?: string; + /** @description Indicates whether a model is custom or default. */ + is_custom_model?: boolean; + /** @description The training date for the custom model. */ + custom_model_training_date?: string | null; + /** @description Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances. */ + total_engaged_users?: number; + /** @description Code completion metrics for active languages, for the given editor. */ + languages?: { + /** @description Name of the language used for Copilot code completion suggestions, for the given editor. */ + name?: string; + /** @description Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language. Includes both full and partial acceptances. */ + total_engaged_users?: number; + /** @description The number of Copilot code suggestions generated for the given editor, for the given language. */ + total_code_suggestions?: number; + /** @description The number of Copilot code suggestions accepted for the given editor, for the given language. Includes both full and partial acceptances. */ + total_code_acceptances?: number; + /** @description The number of lines of code suggested by Copilot code completions for the given editor, for the given language. */ + total_code_lines_suggested?: number; + /** @description The number of lines of code accepted from Copilot code suggestions for the given editor, for the given language. */ + total_code_lines_accepted?: number; + }[]; + }[]; + } & { + [key: string]: unknown; + })[]; + } & { + [key: string]: unknown; + }) | null; + /** @description Usage metrics for Copilot Chat in the IDE. */ + "copilot-ide-chat": ({ + /** @description Total number of users who prompted Copilot Chat in the IDE. */ + total_engaged_users?: number; + editors?: { + /** @description Name of the given editor. */ + name?: string; + /** @description The number of users who prompted Copilot Chat in the specified editor. */ + total_engaged_users?: number; + /** @description List of model metrics for custom models and the default model. */ + models?: { + /** @description Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'. */ + name?: string; + /** @description Indicates whether a model is custom or default. */ + is_custom_model?: boolean; + /** @description The training date for the custom model. */ + custom_model_training_date?: string | null; + /** @description The number of users who prompted Copilot Chat in the given editor and model. */ + total_engaged_users?: number; + /** @description The total number of chats initiated by users in the given editor and model. */ + total_chats?: number; + /** @description The number of times users accepted a code suggestion from Copilot Chat using the 'Insert Code' UI element, for the given editor. */ + total_chat_insertion_events?: number; + /** @description The number of times users copied a code suggestion from Copilot Chat using the keyboard, or the 'Copy' UI element, for the given editor. */ + total_chat_copy_events?: number; + }[]; + }[]; + } & { + [key: string]: unknown; + }) | null; + /** @description Usage metrics for Copilot Chat in github.com */ + "copilot-dotcom-chat": ({ + /** @description Total number of users who prompted Copilot Chat on github.com at least once. */ + total_engaged_users?: number; + /** @description List of model metrics for a custom models and the default model. */ + models?: { + /** @description Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'. */ + name?: string; + /** @description Indicates whether a model is custom or default. */ + is_custom_model?: boolean; + /** @description The training date for the custom model (if applicable). */ + custom_model_training_date?: string | null; + /** @description Total number of users who prompted Copilot Chat on github.com at least once for each model. */ + total_engaged_users?: number; + /** @description Total number of chats initiated by users on github.com. */ + total_chats?: number; + }[]; + } & { + [key: string]: unknown; + }) | null; + /** @description Usage metrics for Copilot for pull requests. */ + "copilot-dotcom-pull-requests": ({ + /** @description The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once. */ + total_engaged_users?: number; + /** @description Repositories in which users used Copilot for Pull Requests to generate pull request summaries */ + repositories?: { + /** @description Repository name */ + name?: string; + /** @description The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository. */ + total_engaged_users?: number; + /** @description List of model metrics for custom models and the default model. */ + models?: { + /** @description Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'. */ + name?: string; + /** @description Indicates whether a model is custom or default. */ + is_custom_model?: boolean; + /** @description The training date for the custom model. */ + custom_model_training_date?: string | null; + /** @description The number of pull request summaries generated using Copilot for Pull Requests in the given repository. */ + total_pr_summaries_created?: number; + /** @description The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository and model. */ + total_engaged_users?: number; + }[]; + }[]; + } & { + [key: string]: unknown; + }) | null; + /** + * Copilot Usage Metrics + * @description Copilot usage metrics for a given day. + */ + "copilot-usage-metrics-day": { + /** + * Format: date + * @description The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format. + */ + date: string; + /** @description The total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint. */ + total_active_users?: number; + /** @description The total number of Copilot users who engaged with any Copilot feature, for the given day. Examples include but are not limited to accepting a code suggestion, prompting Copilot chat, or triggering a PR Summary. Does not include authentication events. Is not limited to the individual features detailed on the endpoint. */ + total_engaged_users?: number; + copilot_ide_code_completions?: components["schemas"]["copilot-ide-code-completions"]; + copilot_ide_chat?: components["schemas"]["copilot-ide-chat"]; + copilot_dotcom_chat?: components["schemas"]["copilot-dotcom-chat"]; + copilot_dotcom_pull_requests?: components["schemas"]["copilot-dotcom-pull-requests"]; + } & { + [key: string]: unknown; + }; + /** + * Copilot Usage Metrics + * @description Summary of Copilot usage. + */ + "copilot-usage-metrics": { + /** + * Format: date + * @description The date for which the usage metrics are reported, in `YYYY-MM-DD` format. + */ + day: string; + /** @description The total number of Copilot code completion suggestions shown to users. */ + total_suggestions_count?: number; + /** @description The total number of Copilot code completion suggestions accepted by users. */ + total_acceptances_count?: number; + /** @description The total number of lines of code completions suggested by Copilot. */ + total_lines_suggested?: number; + /** @description The total number of lines of code completions accepted by users. */ + total_lines_accepted?: number; + /** @description The total number of users who were shown Copilot code completion suggestions during the day specified. */ + total_active_users?: number; + /** @description The total instances of users who accepted code suggested by Copilot Chat in the IDE (panel and inline). */ + total_chat_acceptances?: number; + /** @description The total number of chat turns (prompt and response pairs) sent between users and Copilot Chat in the IDE. */ + total_chat_turns?: number; + /** @description The total number of users who interacted with Copilot Chat in the IDE during the day specified. */ + total_active_chat_users?: number; + /** @description Breakdown of Copilot code completions usage by language and editor */ + breakdown: ({ + /** @description The language in which Copilot suggestions were shown to users in the specified editor. */ + language?: string; + /** @description The editor in which Copilot suggestions were shown to users for the specified language. */ + editor?: string; + /** @description The number of Copilot suggestions shown to users in the editor specified during the day specified. */ + suggestions_count?: number; + /** @description The number of Copilot suggestions accepted by users in the editor specified during the day specified. */ + acceptances_count?: number; + /** @description The number of lines of code suggested by Copilot in the editor specified during the day specified. */ + lines_suggested?: number; + /** @description The number of lines of code accepted by users in the editor specified during the day specified. */ + lines_accepted?: number; + /** @description The number of users who were shown Copilot completion suggestions in the editor specified during the day specified. */ + active_users?: number; + } & { + [key: string]: unknown; + })[] | null; + }; /** * Dependabot Secret for an Organization * @description Secrets for GitHub Dependabot for an organization. @@ -23608,6 +23983,16 @@ export interface components { name: string; /** @description A short description about who this role is for or what permissions it grants. */ description?: string | null; + /** + * @description The system role from which this role inherits permissions. + * @enum {string|null} + */ + base_role?: "read" | "triage" | "write" | "maintain" | "admin" | null; + /** + * @description Source answers the question, "where did this role come from?" + * @enum {string|null} + */ + source?: "Organization" | "Enterprise" | "Predefined" | null; /** @description A list of permissions included in this role. */ permissions: string[]; organization: components["schemas"]["nullable-simple-user"]; @@ -23627,6 +24012,12 @@ export interface components { * @description The Relationship a Team has with a role. */ "team-role-assignment": { + /** + * @description Determines if the team has a direct, indirect, or mixed relationship to a role + * @example direct + * @enum {string} + */ + assignment?: "direct" | "indirect" | "mixed"; id: number; node_id: string; name: string; @@ -23722,6 +24113,14 @@ export interface components { * @description The Relationship a User has with a role. */ "user-role-assignment": { + /** + * @description Determines if the user has a direct, indirect, or mixed relationship to a role + * @example direct + * @enum {string} + */ + assignment?: "direct" | "indirect" | "mixed"; + /** @description Team the user has gotten the role through */ + inherited_from?: components["schemas"]["team-simple"][]; name?: string | null; email?: string | null; /** @example octocat */ @@ -23926,6 +24325,68 @@ export interface components { /** @description Date and time when the associated fine-grained personal access token was last used for authentication. */ token_last_used_at: string | null; }; + /** + * Organization private registry + * @description Private registry configuration for an organization + */ + "org-private-registry-configuration": { + /** + * @description The name of the private registry configuration. + * @example MAVEN_REPOSITORY_SECRET + */ + name: string; + /** + * @description The registry type. + * @enum {string} + */ + registry_type: "maven_repository"; + /** + * @description The username to use when authenticating with the private registry. + * @example monalisa + */ + username?: string | null; + /** + * @description Which type of organization repositories have access to the private registry. + * @enum {string} + */ + visibility: "all" | "private" | "selected"; + /** Format: date-time */ + created_at: string; + /** Format: date-time */ + updated_at: string; + }; + /** + * Organization private registry + * @description Private registry configuration for an organization + */ + "org-private-registry-configuration-with-selected-repositories": { + /** + * @description The name of the private registry configuration. + * @example MAVEN_REPOSITORY_SECRET + */ + name: string; + /** + * @description The registry type. + * @enum {string} + */ + registry_type: "maven_repository"; + /** + * @description The username to use when authenticating with the private registry. + * @example monalisa + */ + username?: string; + /** + * @description Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry. + * @enum {string} + */ + visibility: "all" | "private" | "selected"; + /** @description An array of repository IDs that can access the organization private registry when `visibility` is set to `selected`. */ + selected_repository_ids?: number[]; + /** Format: date-time */ + created_at: string; + /** Format: date-time */ + updated_at: string; + }; /** * Project * @description Projects are a way to organize columns and cards of work. @@ -24003,6 +24464,12 @@ export interface components { * @description The URL that can be used to fetch, update, or delete info about this property via the API. */ url?: string; + /** + * @description The source type of the property + * @example organization + * @enum {string} + */ + source_type?: "organization" | "enterprise"; /** * @description The type of the value for the property * @example single_select @@ -24025,6 +24492,27 @@ export interface components { */ values_editable_by?: "org_actors" | "org_and_repo_actors" | null; }; + /** + * Custom Property Set Payload + * @description Custom property set payload + */ + "custom-property-set-payload": { + /** + * @description The type of the value for the property + * @example single_select + * @enum {string} + */ + value_type: "string" | "single_select" | "multi_select" | "true_false"; + /** @description Whether the property is required. */ + required?: boolean; + /** @description Default value of the property */ + default_value?: (string | string[]) | null; + /** @description Short description of the property */ + description?: string | null; + /** @description An ordered list of the allowed values of the property. + * The property can have up to 200 allowed values. */ + allowed_values?: string[] | null; + }; /** * Custom Property Value * @description Custom property name and associated value @@ -24829,6 +25317,7 @@ export interface components { * @description Conditions for an organization ruleset. * The branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties. * The push rulesets conditions object does not require the `ref_name` property. + * For repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`. */ "org-ruleset-conditions": (components["schemas"]["repository-ruleset-conditions"] & components["schemas"]["repository-ruleset-conditions-repository-name-target"]) | (components["schemas"]["repository-ruleset-conditions"] & components["schemas"]["repository-ruleset-conditions-repository-id-target"]) | (components["schemas"]["repository-ruleset-conditions"] & components["schemas"]["repository-ruleset-conditions-repository-property-target"]); /** @@ -24937,6 +25426,8 @@ export interface components { /** @enum {string} */ type: "pull_request"; parameters?: { + /** @description When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled. */ + allowed_merge_methods?: string[]; /** @description New, reviewable commits pushed will dismiss previous pull request review approvals. */ dismiss_stale_reviews_on_push: boolean; /** @description Require an approving review in pull requests that modify files that have a designated code owner. */ @@ -25202,12 +25693,12 @@ export interface components { * @description The target of the ruleset * @enum {string} */ - target?: "branch" | "tag" | "push"; + target?: "branch" | "tag" | "push" | "repository"; /** * @description The type of the source of the ruleset * @enum {string} */ - source_type?: "Repository" | "Organization"; + source_type?: "Repository" | "Organization" | "Enterprise"; /** @description The name of the source */ source: string; enforcement: components["schemas"]["repository-rule-enforcement"]; @@ -26361,6 +26852,7 @@ export interface components { actions_runner_registration?: components["schemas"]["rate-limit"]; scim?: components["schemas"]["rate-limit"]; dependency_snapshots?: components["schemas"]["rate-limit"]; + code_scanning_autofix?: components["schemas"]["rate-limit"]; }; rate: components["schemas"]["rate-limit"]; }; @@ -27498,6 +27990,7 @@ export interface components { reason: string; payload: string | null; signature: string | null; + verified_at?: string | null; }; /** * Diff Entry @@ -28069,6 +28562,36 @@ export interface components { * @enum {string} */ "code-scanning-alert-set-state": "open" | "dismissed"; + /** + * @description The status of an autofix. + * @enum {string} + */ + "code-scanning-autofix-status": "pending" | "error" | "success" | "outdated"; + /** @description The description of an autofix. */ + "code-scanning-autofix-description": string | null; + /** + * Format: date-time + * @description The start time of an autofix in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + "code-scanning-autofix-started-at": string; + "code-scanning-autofix": { + status: components["schemas"]["code-scanning-autofix-status"]; + description: components["schemas"]["code-scanning-autofix-description"]; + started_at: components["schemas"]["code-scanning-autofix-started-at"]; + }; + /** @description Commit an autofix for a code scanning alert */ + "code-scanning-autofix-commits": { + /** @description The Git reference of target branch for the commit. Branch needs to already exist. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ + target_ref?: string; + /** @description Commit message to be used. */ + message?: string; + } | null; + "code-scanning-autofix-commits-response": { + /** @description The Git reference of target branch for the commit. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ + target_ref?: string; + /** @description SHA of commit with autofix. */ + sha?: string; + }; /** * @description An identifier for the upload. * @example 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53 @@ -28298,7 +28821,7 @@ export interface components { */ state?: "configured" | "not-configured"; /** @description Languages to be analyzed. */ - languages?: ("c-cpp" | "csharp" | "go" | "java-kotlin" | "javascript-typescript" | "javascript" | "python" | "ruby" | "typescript" | "swift")[]; + languages?: ("actions" | "c-cpp" | "csharp" | "go" | "java-kotlin" | "javascript-typescript" | "javascript" | "python" | "ruby" | "typescript" | "swift")[]; /** * @description CodeQL query suite to be used. * @enum {string} @@ -28323,13 +28846,23 @@ export interface components { * @enum {string} */ state?: "configured" | "not-configured"; + /** + * @description Runner type to be used. + * @enum {string} + */ + runner_type?: "standard" | "labeled"; + /** + * @description Runner label to be used if the runner type is labeled. + * @example code-scanning + */ + runner_label?: string | null; /** * @description CodeQL query suite to be used. * @enum {string} */ query_suite?: "default" | "extended"; /** @description CodeQL languages to be analyzed. */ - languages?: ("c-cpp" | "csharp" | "go" | "java-kotlin" | "javascript-typescript" | "python" | "ruby" | "swift")[]; + languages?: ("actions" | "c-cpp" | "csharp" | "go" | "java-kotlin" | "javascript-typescript" | "python" | "ruby" | "swift")[]; }; /** @description You can use `run_url` to track the status of the run. This includes a property status and conclusion. * You should not rely on this always being an actions workflow run object. */ @@ -29285,6 +29818,7 @@ export interface components { reason?: string; signature?: string | null; payload?: string | null; + verified_at?: string | null; }; }; }; @@ -30039,6 +30573,7 @@ export interface components { reason: string; signature: string | null; payload: string | null; + verified_at?: string | null; }; /** Format: uri */ html_url: string; @@ -30400,6 +30935,7 @@ export interface components { performed_via_github_app?: components["schemas"]["nullable-integration"]; author_association: components["schemas"]["author-association"]; reactions?: components["schemas"]["reaction-rollup"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; } | null; /** * Issue Event Label @@ -30978,6 +31514,7 @@ export interface components { reason: string; signature: string | null; payload: string | null; + verified_at?: string | null; }; /** Format: uri */ html_url: string; @@ -32114,6 +32651,16 @@ export interface components { * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ push_protection_bypassed_at?: string | null; + push_protection_bypass_request_reviewer?: components["schemas"]["nullable-simple-user"]; + /** @description An optional comment when reviewing a push protection bypass. */ + push_protection_bypass_request_reviewer_comment?: string | null; + /** @description An optional comment when requesting a push protection bypass. */ + push_protection_bypass_request_comment?: string | null; + /** + * Format: uri + * @description The URL to a push protection bypass request. + */ + push_protection_bypass_request_html_url?: string | null; /** * @description The token status as of the latest validity check. * @enum {string} @@ -32251,7 +32798,7 @@ export interface components { /** * Format: uri * @description The API URL to get the pull request where the secret was detected. - * @example https://api.github.com/repos/octocat/Hello-World/pull/2846 + * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846 */ pull_request_title_url: string; }; @@ -32260,7 +32807,7 @@ export interface components { /** * Format: uri * @description The API URL to get the pull request where the secret was detected. - * @example https://api.github.com/repos/octocat/Hello-World/pull/2846 + * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846 */ pull_request_body_url: string; }; @@ -32315,6 +32862,34 @@ export interface components { /** @description The token type this bypass is for. */ token_type?: string; }; + /** @description Information on a single scan performed by secret scanning on the repository */ + "secret-scanning-scan": { + /** @description The type of scan */ + type?: string; + /** @description The state of the scan. Either "completed", "running", or "pending" */ + status?: string; + /** + * Format: date-time + * @description The time that the scan was completed. Empty if the scan is running + */ + completed_at?: string | null; + /** + * Format: date-time + * @description The time that the scan was started. Empty if the scan is pending + */ + started_at?: string | null; + }; + "secret-scanning-scan-history": { + incremental_scans?: components["schemas"]["secret-scanning-scan"][]; + pattern_update_scans?: components["schemas"]["secret-scanning-scan"][]; + backfill_scans?: components["schemas"]["secret-scanning-scan"][]; + custom_pattern_backfill_scans?: (components["schemas"]["secret-scanning-scan"] & { + /** @description Name of the custom pattern for custom pattern scans */ + pattern_name?: string; + /** @description Level at which the custom pattern is defined, one of "repository", "organization", or "enterprise" */ + pattern_scope?: string; + })[]; + }; "repository-advisory-create": { /** @description A short summary of the advisory. */ summary: string; @@ -32749,6 +33324,12 @@ export interface components { default?: boolean; description?: string | null; }[]; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; state: string; state_reason?: string | null; assignee: components["schemas"]["nullable-simple-user"]; @@ -35340,6 +35921,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -35828,6 +36415,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -38908,6 +39501,16 @@ export interface components { * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ push_protection_bypassed_at?: string | null; + push_protection_bypass_request_reviewer?: components["schemas"]["nullable-simple-user"]; + /** @description An optional comment when reviewing a push protection bypass. */ + push_protection_bypass_request_reviewer_comment?: string | null; + /** @description An optional comment when requesting a push protection bypass. */ + push_protection_bypass_request_comment?: string | null; + /** + * Format: uri + * @description The URL to a push protection bypass request. + */ + push_protection_bypass_request_html_url?: string | null; /** @description Whether the detected secret was publicly leaked. */ publicly_leaked?: boolean | null; /** @description Whether the detected secret was found in multiple repositories in the same organization or business. */ @@ -43992,21 +44595,424 @@ export interface components { * @enum {string} */ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue comment */ - body: string; + /** @description Contents of the issue comment */ + body: string; + /** Format: date-time */ + created_at: string; + /** Format: uri */ + html_url: string; + /** + * Format: int64 + * @description Unique identifier of the issue comment + */ + id: number; + /** Format: uri */ + issue_url: string; + node_id: string; + performed_via_github_app: components["schemas"]["nullable-integration"]; + /** Reactions */ + reactions: { + "+1": number; + "-1": number; + confused: number; + eyes: number; + heart: number; + hooray: number; + laugh: number; + rocket: number; + total_count: number; + /** Format: uri */ + url: string; + }; + /** Format: date-time */ + updated_at: string; + /** + * Format: uri + * @description URL for the issue comment + */ + url: string; + /** User */ + user: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + /** Format: int64 */ + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null; + }; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. */ + issue: { + /** @enum {string|null} */ + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + /** User */ + assignee?: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization" | "Mannequin"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null; + assignees: ({ + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization" | "Mannequin"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null)[]; + /** + * AuthorAssociation + * @description How the author is associated with the repository. + * @enum {string} + */ + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + /** @description Contents of the issue */ + body: string | null; + /** Format: date-time */ + closed_at: string | null; + comments: number; + /** Format: uri */ + comments_url: string; /** Format: date-time */ created_at: string; + draft?: boolean; + /** Format: uri */ + events_url: string; /** Format: uri */ html_url: string; + /** Format: int64 */ + id: number; + labels?: { + /** @description 6-character hex code, without the leading #, identifying the color */ + color: string; + default: boolean; + description: string | null; + id: number; + /** @description The name of the label. */ + name: string; + node_id: string; + /** + * Format: uri + * @description URL for the label + */ + url: string; + }[]; + /** Format: uri-template */ + labels_url: string; + locked?: boolean; /** - * Format: int64 - * @description Unique identifier of the issue comment + * Milestone + * @description A collection of related issues and pull requests. */ - id: number; - /** Format: uri */ - issue_url: string; + milestone: { + /** Format: date-time */ + closed_at: string | null; + closed_issues: number; + /** Format: date-time */ + created_at: string; + /** User */ + creator: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization" | "Mannequin"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null; + description: string | null; + /** Format: date-time */ + due_on: string | null; + /** Format: uri */ + html_url: string; + id: number; + /** Format: uri */ + labels_url: string; + node_id: string; + /** @description The number of the milestone. */ + number: number; + open_issues: number; + /** + * @description The state of the milestone. + * @enum {string} + */ + state: "open" | "closed"; + /** @description The title of the milestone. */ + title: string; + /** Format: date-time */ + updated_at: string; + /** Format: uri */ + url: string; + } | null; node_id: string; - performed_via_github_app: components["schemas"]["nullable-integration"]; + number: number; + /** + * App + * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. + */ + performed_via_github_app?: { + /** Format: date-time */ + created_at: string | null; + description: string | null; + /** @description The list of events for the GitHub app */ + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "pull_request_review_thread")[]; + /** Format: uri */ + external_url: string | null; + /** Format: uri */ + html_url: string; + /** @description Unique identifier of the GitHub app */ + id: number | null; + /** @description The name of the GitHub app */ + name: string; + node_id: string; + /** User */ + owner: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null; + /** @description The set of permissions for the GitHub app */ + permissions?: { + /** @enum {string} */ + actions?: "read" | "write"; + /** @enum {string} */ + administration?: "read" | "write"; + /** @enum {string} */ + checks?: "read" | "write"; + /** @enum {string} */ + content_references?: "read" | "write"; + /** @enum {string} */ + contents?: "read" | "write"; + /** @enum {string} */ + deployments?: "read" | "write"; + /** @enum {string} */ + discussions?: "read" | "write"; + /** @enum {string} */ + emails?: "read" | "write"; + /** @enum {string} */ + environments?: "read" | "write"; + /** @enum {string} */ + issues?: "read" | "write"; + /** @enum {string} */ + keys?: "read" | "write"; + /** @enum {string} */ + members?: "read" | "write"; + /** @enum {string} */ + metadata?: "read" | "write"; + /** @enum {string} */ + organization_administration?: "read" | "write"; + /** @enum {string} */ + organization_hooks?: "read" | "write"; + /** @enum {string} */ + organization_packages?: "read" | "write"; + /** @enum {string} */ + organization_plan?: "read" | "write"; + /** @enum {string} */ + organization_projects?: "read" | "write" | "admin"; + /** @enum {string} */ + organization_secrets?: "read" | "write"; + /** @enum {string} */ + organization_self_hosted_runners?: "read" | "write"; + /** @enum {string} */ + organization_user_blocking?: "read" | "write"; + /** @enum {string} */ + packages?: "read" | "write"; + /** @enum {string} */ + pages?: "read" | "write"; + /** @enum {string} */ + pull_requests?: "read" | "write"; + /** @enum {string} */ + repository_hooks?: "read" | "write"; + /** @enum {string} */ + repository_projects?: "read" | "write" | "admin"; + /** @enum {string} */ + secret_scanning_alerts?: "read" | "write"; + /** @enum {string} */ + secrets?: "read" | "write"; + /** @enum {string} */ + security_events?: "read" | "write"; + /** @enum {string} */ + security_scanning_alert?: "read" | "write"; + /** @enum {string} */ + single_file?: "read" | "write"; + /** @enum {string} */ + statuses?: "read" | "write"; + /** @enum {string} */ + team_discussions?: "read" | "write"; + /** @enum {string} */ + vulnerability_alerts?: "read" | "write"; + /** @enum {string} */ + workflows?: "read" | "write"; + }; + /** @description The slug name of the GitHub app */ + slug?: string; + /** Format: date-time */ + updated_at: string | null; + } | null; + pull_request?: { + /** Format: uri */ + diff_url?: string; + /** Format: uri */ + html_url?: string; + /** Format: date-time */ + merged_at?: string | null; + /** Format: uri */ + patch_url?: string; + /** Format: uri */ + url?: string; + }; /** Reactions */ reactions: { "+1": number; @@ -44021,11 +45027,29 @@ export interface components { /** Format: uri */ url: string; }; + /** Format: uri */ + repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; + /** + * @description State of the issue; either 'open' or 'closed' + * @enum {string} + */ + state?: "open" | "closed"; + state_reason?: string | null; + /** Format: uri */ + timeline_url?: string; + /** @description Title of the issue */ + title: string; /** Format: date-time */ updated_at: string; /** * Format: uri - * @description URL for the issue comment + * @description URL for the issue */ url: string; /** User */ @@ -44062,12 +45086,135 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null; + } & { + active_lock_reason?: string | null; + /** User */ + assignee: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; user_view_type?: string; } | null; + assignees?: Record[]; + author_association?: string; + body?: string | null; + closed_at?: string | null; + comments?: number; + comments_url?: string; + created_at?: string; + events_url?: string; + html_url?: string; + id?: number; + labels: { + /** @description 6-character hex code, without the leading #, identifying the color */ + color: string; + default: boolean; + description: string | null; + id: number; + /** @description The name of the label. */ + name: string; + node_id: string; + /** + * Format: uri + * @description URL for the label + */ + url: string; + }[]; + labels_url?: string; + locked: boolean; + milestone?: Record; + node_id?: string; + number?: number; + performed_via_github_app?: Record; + reactions?: { + "+1"?: number; + "-1"?: number; + confused?: number; + eyes?: number; + heart?: number; + hooray?: number; + laugh?: number; + rocket?: number; + total_count?: number; + url?: string; + }; + repository_url?: string; + /** + * @description State of the issue; either 'open' or 'closed' + * @enum {string} + */ + state: "open" | "closed"; + timeline_url?: string; + title?: string; + updated_at?: string; + url?: string; + user?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + /** Format: int64 */ + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: string; + url?: string; + }; }; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; + }; + /** issue_comment deleted event */ + "webhook-issue-comment-deleted": { + /** @enum {string} */ + action: "deleted"; + comment: components["schemas"]["webhooks_issue_comment"]; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. */ @@ -44272,7 +45419,7 @@ export interface components { created_at: string | null; description: string | null; /** @description The list of events for the GitHub app */ - events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "pull_request_review_thread")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; /** Format: uri */ external_url: string | null; /** Format: uri */ @@ -44357,7 +45504,7 @@ export interface components { /** @enum {string} */ organization_plan?: "read" | "write"; /** @enum {string} */ - organization_projects?: "read" | "write" | "admin"; + organization_projects?: "read" | "write"; /** @enum {string} */ organization_secrets?: "read" | "write"; /** @enum {string} */ @@ -44373,7 +45520,7 @@ export interface components { /** @enum {string} */ repository_hooks?: "read" | "write"; /** @enum {string} */ - repository_projects?: "read" | "write" | "admin"; + repository_projects?: "read" | "write"; /** @enum {string} */ secret_scanning_alerts?: "read" | "write"; /** @enum {string} */ @@ -44426,6 +45573,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -44595,16 +45748,18 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; }; - /** issue_comment deleted event */ - "webhook-issue-comment-deleted": { + /** issue_comment edited event */ + "webhook-issue-comment-edited": { /** @enum {string} */ - action: "deleted"; + action: "edited"; + changes: components["schemas"]["webhooks_changes"]; comment: components["schemas"]["webhooks_issue_comment"]; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; @@ -44810,7 +45965,7 @@ export interface components { created_at: string | null; description: string | null; /** @description The list of events for the GitHub app */ - events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "pull_request_review_thread")[]; /** Format: uri */ external_url: string | null; /** Format: uri */ @@ -44895,7 +46050,7 @@ export interface components { /** @enum {string} */ organization_plan?: "read" | "write"; /** @enum {string} */ - organization_projects?: "read" | "write"; + organization_projects?: "read" | "write" | "admin"; /** @enum {string} */ organization_secrets?: "read" | "write"; /** @enum {string} */ @@ -44964,6 +46119,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -45133,22 +46294,37 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; - user_view_type?: string; }; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; }; - /** issue_comment edited event */ - "webhook-issue-comment-edited": { - /** @enum {string} */ - action: "edited"; - changes: components["schemas"]["webhooks_changes"]; - comment: components["schemas"]["webhooks_issue_comment"]; + /** issues assigned event */ + "webhook-issues-assigned": { + /** + * @description The action that was performed. + * @enum {string} + */ + action: "assigned"; + assignee?: components["schemas"]["webhooks_user"]; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; - /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. */ + issue: components["schemas"]["webhooks_issue"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; + }; + /** issues closed event */ + "webhook-issues-closed": { + /** + * @description The action that was performed. + * @enum {string} + */ + action: "closed"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ issue: { /** @enum {string|null} */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; @@ -45350,7 +46526,7 @@ export interface components { created_at: string | null; description: string | null; /** @description The list of events for the GitHub app */ - events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "pull_request_review_thread")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "security_and_analysis" | "reminder" | "pull_request_review_thread")[]; /** Format: uri */ external_url: string | null; /** Format: uri */ @@ -45504,6 +46680,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -45562,71 +46744,20 @@ export interface components { } | null; } & { active_lock_reason?: string | null; - /** User */ - assignee: { - /** Format: uri */ - avatar_url?: string; - deleted?: boolean; - email?: string | null; - /** Format: uri-template */ - events_url?: string; - /** Format: uri */ - followers_url?: string; - /** Format: uri-template */ - following_url?: string; - /** Format: uri-template */ - gists_url?: string; - gravatar_id?: string; - /** Format: uri */ - html_url?: string; - id: number; - login: string; - name?: string; - node_id?: string; - /** Format: uri */ - organizations_url?: string; - /** Format: uri */ - received_events_url?: string; - /** Format: uri */ - repos_url?: string; - site_admin?: boolean; - /** Format: uri-template */ - starred_url?: string; - /** Format: uri */ - subscriptions_url?: string; - /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ - url?: string; - user_view_type?: string; - } | null; + assignee?: Record; assignees?: Record[]; author_association?: string; body?: string | null; - closed_at?: string | null; + closed_at: string | null; comments?: number; comments_url?: string; created_at?: string; events_url?: string; html_url?: string; id?: number; - labels: { - /** @description 6-character hex code, without the leading #, identifying the color */ - color: string; - default: boolean; - description: string | null; - id: number; - /** @description The name of the label. */ - name: string; - node_id: string; - /** - * Format: uri - * @description URL for the label - */ - url: string; - }[]; + labels?: Record[]; labels_url?: string; - locked: boolean; + locked?: boolean; milestone?: Record; node_id?: string; number?: number; @@ -45644,11 +46775,8 @@ export interface components { url?: string; }; repository_url?: string; - /** - * @description State of the issue; either 'open' or 'closed' - * @enum {string} - */ - state: "open" | "closed"; + /** @enum {string} */ + state: "closed" | "open"; timeline_url?: string; title?: string; updated_at?: string; @@ -45673,37 +46801,23 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; }; - /** issues assigned event */ - "webhook-issues-assigned": { - /** - * @description The action that was performed. - * @enum {string} - */ - action: "assigned"; - assignee?: components["schemas"]["webhooks_user"]; + /** issues deleted event */ + "webhook-issues-deleted": { + /** @enum {string} */ + action: "deleted"; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; - issue: components["schemas"]["webhooks_issue"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user"]; - }; - /** issues closed event */ - "webhook-issues-closed": { /** - * @description The action that was performed. - * @enum {string} + * Issue + * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ - action: "closed"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ issue: { /** @enum {string|null} */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; @@ -45740,7 +46854,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; user_view_type?: string; @@ -45777,10 +46891,9 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; - user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -45865,7 +46978,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; user_view_type?: string; @@ -45905,7 +47018,7 @@ export interface components { created_at: string | null; description: string | null; /** @description The list of events for the GitHub app */ - events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "security_and_analysis" | "reminder" | "pull_request_review_thread")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder")[]; /** Format: uri */ external_url: string | null; /** Format: uri */ @@ -45990,7 +47103,7 @@ export interface components { /** @enum {string} */ organization_plan?: "read" | "write"; /** @enum {string} */ - organization_projects?: "read" | "write" | "admin"; + organization_projects?: "read" | "write"; /** @enum {string} */ organization_secrets?: "read" | "write"; /** @enum {string} */ @@ -46059,6 +47172,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -46110,81 +47229,20 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; user_view_type?: string; } | null; - } & { - active_lock_reason?: string | null; - assignee?: Record; - assignees?: Record[]; - author_association?: string; - body?: string | null; - closed_at: string | null; - comments?: number; - comments_url?: string; - created_at?: string; - events_url?: string; - html_url?: string; - id?: number; - labels?: Record[]; - labels_url?: string; - locked?: boolean; - milestone?: Record; - node_id?: string; - number?: number; - performed_via_github_app?: Record; - reactions?: { - "+1"?: number; - "-1"?: number; - confused?: number; - eyes?: number; - heart?: number; - hooray?: number; - laugh?: number; - rocket?: number; - total_count?: number; - url?: string; - }; - repository_url?: string; - /** @enum {string} */ - state: "closed" | "open"; - timeline_url?: string; - title?: string; - updated_at?: string; - url?: string; - user?: { - avatar_url?: string; - events_url?: string; - followers_url?: string; - following_url?: string; - gists_url?: string; - gravatar_id?: string; - html_url?: string; - /** Format: int64 */ - id?: number; - login?: string; - node_id?: string; - organizations_url?: string; - received_events_url?: string; - repos_url?: string; - site_admin?: boolean; - starred_url?: string; - subscriptions_url?: string; - type?: string; - url?: string; - user_view_type?: string; - }; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; }; - /** issues deleted event */ - "webhook-issues-deleted": { + /** issues demilestoned event */ + "webhook-issues-demilestoned": { /** @enum {string} */ - action: "deleted"; + action: "demilestoned"; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** @@ -46227,10 +47285,9 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -46264,7 +47321,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; } | null)[]; @@ -46290,7 +47347,7 @@ export interface components { html_url: string; /** Format: int64 */ id: number; - labels?: { + labels?: ({ /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; @@ -46304,7 +47361,7 @@ export interface components { * @description URL for the label */ url: string; - }[]; + } | null)[]; /** Format: uri-template */ labels_url: string; locked?: boolean; @@ -46351,7 +47408,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; user_view_type?: string; @@ -46391,7 +47448,7 @@ export interface components { created_at: string | null; description: string | null; /** @description The list of events for the GitHub app */ - events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; /** Format: uri */ external_url: string | null; /** Format: uri */ @@ -46476,7 +47533,7 @@ export interface components { /** @enum {string} */ organization_plan?: "read" | "write"; /** @enum {string} */ - organization_projects?: "read" | "write"; + organization_projects?: "read" | "write" | "admin"; /** @enum {string} */ organization_secrets?: "read" | "write"; /** @enum {string} */ @@ -46545,6 +47602,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -46596,20 +47659,32 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; user_view_type?: string; } | null; }; + milestone?: components["schemas"]["webhooks_milestone"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; }; - /** issues demilestoned event */ - "webhook-issues-demilestoned": { + /** issues edited event */ + "webhook-issues-edited": { /** @enum {string} */ - action: "demilestoned"; + action: "edited"; + /** @description The changes to the issue. */ + changes: { + body?: { + /** @description The previous version of the body. */ + from: string; + }; + title?: { + /** @description The previous version of the title. */ + from: string; + }; + }; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** @@ -46655,6 +47730,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -46714,7 +47790,7 @@ export interface components { html_url: string; /** Format: int64 */ id: number; - labels?: ({ + labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; @@ -46728,7 +47804,7 @@ export interface components { * @description URL for the label */ url: string; - } | null)[]; + }[]; /** Format: uri-template */ labels_url: string; locked?: boolean; @@ -46815,7 +47891,7 @@ export interface components { created_at: string | null; description: string | null; /** @description The list of events for the GitHub app */ - events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "security_and_analysis" | "pull_request_review_thread" | "reminder")[]; /** Format: uri */ external_url: string | null; /** Format: uri */ @@ -46969,6 +48045,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -47026,26 +48108,15 @@ export interface components { user_view_type?: string; } | null; }; - milestone?: components["schemas"]["webhooks_milestone"]; + label?: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; }; - /** issues edited event */ - "webhook-issues-edited": { + /** issues labeled event */ + "webhook-issues-labeled": { /** @enum {string} */ - action: "edited"; - /** @description The changes to the issue. */ - changes: { - body?: { - /** @description The previous version of the body. */ - from: string; - }; - title?: { - /** @description The previous version of the title. */ - from: string; - }; - }; + action: "labeled"; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** @@ -47252,7 +48323,7 @@ export interface components { created_at: string | null; description: string | null; /** @description The list of events for the GitHub app */ - events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "security_and_analysis" | "pull_request_review_thread" | "reminder")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "reminder")[]; /** Format: uri */ external_url: string | null; /** Format: uri */ @@ -47406,6 +48477,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -47468,10 +48545,10 @@ export interface components { repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; }; - /** issues labeled event */ - "webhook-issues-labeled": { + /** issues locked event */ + "webhook-issues-locked": { /** @enum {string} */ - action: "labeled"; + action: "locked"; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** @@ -47514,7 +48591,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; user_view_type?: string; @@ -47551,9 +48628,10 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -47577,7 +48655,7 @@ export interface components { html_url: string; /** Format: int64 */ id: number; - labels?: { + labels?: ({ /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; @@ -47591,10 +48669,11 @@ export interface components { * @description URL for the label */ url: string; - }[]; + } | null)[]; /** Format: uri-template */ labels_url: string; - locked?: boolean; + /** @enum {boolean} */ + locked: true; /** * Milestone * @description A collection of related issues and pull requests. @@ -47638,7 +48717,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; user_view_type?: string; @@ -47678,7 +48757,7 @@ export interface components { created_at: string | null; description: string | null; /** @description The list of events for the GitHub app */ - events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "reminder")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "security_and_analysis")[]; /** Format: uri */ external_url: string | null; /** Format: uri */ @@ -47763,7 +48842,7 @@ export interface components { /** @enum {string} */ organization_plan?: "read" | "write"; /** @enum {string} */ - organization_projects?: "read" | "write" | "admin"; + organization_projects?: "read" | "write"; /** @enum {string} */ organization_secrets?: "read" | "write"; /** @enum {string} */ @@ -47832,6 +48911,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -47883,21 +48968,20 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; user_view_type?: string; } | null; }; - label?: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; }; - /** issues locked event */ - "webhook-issues-locked": { + /** issues milestoned event */ + "webhook-issues-milestoned": { /** @enum {string} */ - action: "locked"; + action: "milestoned"; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** @@ -47943,7 +49027,6 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; - user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -47980,7 +49063,6 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; - user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -48021,8 +49103,7 @@ export interface components { } | null)[]; /** Format: uri-template */ labels_url: string; - /** @enum {boolean} */ - locked: true; + locked?: boolean; /** * Milestone * @description A collection of related issues and pull requests. @@ -48066,7 +49147,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; user_view_type?: string; @@ -48106,7 +49187,7 @@ export interface components { created_at: string | null; description: string | null; /** @description The list of events for the GitHub app */ - events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "security_and_analysis")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder")[]; /** Format: uri */ external_url: string | null; /** Format: uri */ @@ -48191,7 +49272,7 @@ export interface components { /** @enum {string} */ organization_plan?: "read" | "write"; /** @enum {string} */ - organization_projects?: "read" | "write"; + organization_projects?: "read" | "write" | "admin"; /** @enum {string} */ organization_secrets?: "read" | "write"; /** @enum {string} */ @@ -48260,430 +49341,12 @@ export interface components { }; /** Format: uri */ repository_url: string; - /** - * @description State of the issue; either 'open' or 'closed' - * @enum {string} - */ - state?: "open" | "closed"; - state_reason?: string | null; - /** Format: uri */ - timeline_url?: string; - /** @description Title of the issue */ - title: string; - /** Format: date-time */ - updated_at: string; - /** - * Format: uri - * @description URL for the issue - */ - url: string; - /** User */ - user: { - /** Format: uri */ - avatar_url?: string; - deleted?: boolean; - email?: string | null; - /** Format: uri-template */ - events_url?: string; - /** Format: uri */ - followers_url?: string; - /** Format: uri-template */ - following_url?: string; - /** Format: uri-template */ - gists_url?: string; - gravatar_id?: string; - /** Format: uri */ - html_url?: string; - /** Format: int64 */ - id: number; - login: string; - name?: string; - node_id?: string; - /** Format: uri */ - organizations_url?: string; - /** Format: uri */ - received_events_url?: string; - /** Format: uri */ - repos_url?: string; - site_admin?: boolean; - /** Format: uri-template */ - starred_url?: string; - /** Format: uri */ - subscriptions_url?: string; - /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; - /** Format: uri */ - url?: string; - user_view_type?: string; - } | null; - }; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user"]; - }; - /** issues milestoned event */ - "webhook-issues-milestoned": { - /** @enum {string} */ - action: "milestoned"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - /** - * Issue - * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. - */ - issue: { - /** @enum {string|null} */ - active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ - assignee?: { - /** Format: uri */ - avatar_url?: string; - deleted?: boolean; - email?: string | null; - /** Format: uri-template */ - events_url?: string; - /** Format: uri */ - followers_url?: string; - /** Format: uri-template */ - following_url?: string; - /** Format: uri-template */ - gists_url?: string; - gravatar_id?: string; - /** Format: uri */ - html_url?: string; - id: number; - login: string; - name?: string; - node_id?: string; - /** Format: uri */ - organizations_url?: string; - /** Format: uri */ - received_events_url?: string; - /** Format: uri */ - repos_url?: string; - site_admin?: boolean; - /** Format: uri-template */ - starred_url?: string; - /** Format: uri */ - subscriptions_url?: string; - /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; - /** Format: uri */ - url?: string; - } | null; - assignees: ({ - /** Format: uri */ - avatar_url?: string; - deleted?: boolean; - email?: string | null; - /** Format: uri-template */ - events_url?: string; - /** Format: uri */ - followers_url?: string; - /** Format: uri-template */ - following_url?: string; - /** Format: uri-template */ - gists_url?: string; - gravatar_id?: string; - /** Format: uri */ - html_url?: string; - id: number; - login: string; - name?: string; - node_id?: string; - /** Format: uri */ - organizations_url?: string; - /** Format: uri */ - received_events_url?: string; - /** Format: uri */ - repos_url?: string; - site_admin?: boolean; - /** Format: uri-template */ - starred_url?: string; - /** Format: uri */ - subscriptions_url?: string; - /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; - /** Format: uri */ - url?: string; - } | null)[]; - /** - * AuthorAssociation - * @description How the author is associated with the repository. - * @enum {string} - */ - author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ - body: string | null; - /** Format: date-time */ - closed_at: string | null; - comments: number; - /** Format: uri */ - comments_url: string; - /** Format: date-time */ - created_at: string; - draft?: boolean; - /** Format: uri */ - events_url: string; - /** Format: uri */ - html_url: string; - /** Format: int64 */ - id: number; - labels?: ({ - /** @description 6-character hex code, without the leading #, identifying the color */ - color: string; - default: boolean; - description: string | null; - id: number; - /** @description The name of the label. */ - name: string; - node_id: string; - /** - * Format: uri - * @description URL for the label - */ - url: string; - } | null)[]; - /** Format: uri-template */ - labels_url: string; - locked?: boolean; - /** - * Milestone - * @description A collection of related issues and pull requests. - */ - milestone: { - /** Format: date-time */ - closed_at: string | null; - closed_issues: number; - /** Format: date-time */ - created_at: string; - /** User */ - creator: { - /** Format: uri */ - avatar_url?: string; - deleted?: boolean; - email?: string | null; - /** Format: uri-template */ - events_url?: string; - /** Format: uri */ - followers_url?: string; - /** Format: uri-template */ - following_url?: string; - /** Format: uri-template */ - gists_url?: string; - gravatar_id?: string; - /** Format: uri */ - html_url?: string; - id: number; - login: string; - name?: string; - node_id?: string; - /** Format: uri */ - organizations_url?: string; - /** Format: uri */ - received_events_url?: string; - /** Format: uri */ - repos_url?: string; - site_admin?: boolean; - /** Format: uri-template */ - starred_url?: string; - /** Format: uri */ - subscriptions_url?: string; - /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ - url?: string; - user_view_type?: string; - } | null; - description: string | null; - /** Format: date-time */ - due_on: string | null; - /** Format: uri */ - html_url: string; - id: number; - /** Format: uri */ - labels_url: string; - node_id: string; - /** @description The number of the milestone. */ - number: number; - open_issues: number; - /** - * @description The state of the milestone. - * @enum {string} - */ - state: "open" | "closed"; - /** @description The title of the milestone. */ - title: string; - /** Format: date-time */ - updated_at: string; - /** Format: uri */ - url: string; - } | null; - node_id: string; - number: number; - /** - * App - * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. - */ - performed_via_github_app?: { - /** Format: date-time */ - created_at: string | null; - description: string | null; - /** @description The list of events for the GitHub app */ - events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder")[]; - /** Format: uri */ - external_url: string | null; - /** Format: uri */ - html_url: string; - /** @description Unique identifier of the GitHub app */ - id: number | null; - /** @description The name of the GitHub app */ - name: string; - node_id: string; - /** User */ - owner: { - /** Format: uri */ - avatar_url?: string; - deleted?: boolean; - email?: string | null; - /** Format: uri-template */ - events_url?: string; - /** Format: uri */ - followers_url?: string; - /** Format: uri-template */ - following_url?: string; - /** Format: uri-template */ - gists_url?: string; - gravatar_id?: string; - /** Format: uri */ - html_url?: string; - id: number; - login: string; - name?: string; - node_id?: string; - /** Format: uri */ - organizations_url?: string; - /** Format: uri */ - received_events_url?: string; - /** Format: uri */ - repos_url?: string; - site_admin?: boolean; - /** Format: uri-template */ - starred_url?: string; - /** Format: uri */ - subscriptions_url?: string; - /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; - /** Format: uri */ - url?: string; - user_view_type?: string; - } | null; - /** @description The set of permissions for the GitHub app */ - permissions?: { - /** @enum {string} */ - actions?: "read" | "write"; - /** @enum {string} */ - administration?: "read" | "write"; - /** @enum {string} */ - checks?: "read" | "write"; - /** @enum {string} */ - content_references?: "read" | "write"; - /** @enum {string} */ - contents?: "read" | "write"; - /** @enum {string} */ - deployments?: "read" | "write"; - /** @enum {string} */ - discussions?: "read" | "write"; - /** @enum {string} */ - emails?: "read" | "write"; - /** @enum {string} */ - environments?: "read" | "write"; - /** @enum {string} */ - issues?: "read" | "write"; - /** @enum {string} */ - keys?: "read" | "write"; - /** @enum {string} */ - members?: "read" | "write"; - /** @enum {string} */ - metadata?: "read" | "write"; - /** @enum {string} */ - organization_administration?: "read" | "write"; - /** @enum {string} */ - organization_hooks?: "read" | "write"; - /** @enum {string} */ - organization_packages?: "read" | "write"; - /** @enum {string} */ - organization_plan?: "read" | "write"; - /** @enum {string} */ - organization_projects?: "read" | "write" | "admin"; - /** @enum {string} */ - organization_secrets?: "read" | "write"; - /** @enum {string} */ - organization_self_hosted_runners?: "read" | "write"; - /** @enum {string} */ - organization_user_blocking?: "read" | "write"; - /** @enum {string} */ - packages?: "read" | "write"; - /** @enum {string} */ - pages?: "read" | "write"; - /** @enum {string} */ - pull_requests?: "read" | "write"; - /** @enum {string} */ - repository_hooks?: "read" | "write"; - /** @enum {string} */ - repository_projects?: "read" | "write"; - /** @enum {string} */ - secret_scanning_alerts?: "read" | "write"; - /** @enum {string} */ - secrets?: "read" | "write"; - /** @enum {string} */ - security_events?: "read" | "write"; - /** @enum {string} */ - security_scanning_alert?: "read" | "write"; - /** @enum {string} */ - single_file?: "read" | "write"; - /** @enum {string} */ - statuses?: "read" | "write"; - /** @enum {string} */ - team_discussions?: "read" | "write"; - /** @enum {string} */ - vulnerability_alerts?: "read" | "write"; - /** @enum {string} */ - workflows?: "read" | "write"; - }; - /** @description The slug name of the GitHub app */ - slug?: string; - /** Format: date-time */ - updated_at: string | null; - } | null; - pull_request?: { - /** Format: uri */ - diff_url?: string; - /** Format: uri */ - html_url?: string; - /** Format: date-time */ - merged_at?: string | null; - /** Format: uri */ - patch_url?: string; - /** Format: uri */ - url?: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; }; - /** Reactions */ - reactions: { - "+1": number; - "-1": number; - confused: number; - eyes: number; - heart: number; - hooray: number; - laugh: number; - rocket: number; - total_count: number; - /** Format: uri */ - url: string; - }; - /** Format: uri */ - repository_url: string; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -49110,6 +49773,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -49776,6 +50445,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -50211,6 +50886,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -50636,6 +51317,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -51344,6 +52031,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -82571,6 +83264,45 @@ export interface components { repository: components["schemas"]["repository-webhooks"]; sender?: components["schemas"]["simple-user"]; }; + /** secret_scanning_scan completed event */ + "webhook-secret-scanning-scan-completed": { + /** @enum {string} */ + action: "completed"; + /** + * @description What type of scan was completed + * @enum {string} + */ + type: "backfill" | "custom-pattern-backfill" | "pattern-version-backfill"; + /** + * @description What type of content was scanned + * @enum {string} + */ + source: "git" | "issues" | "pull-requests" | "discussions" | "wiki"; + /** + * Format: date-time + * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + started_at: string; + /** + * Format: date-time + * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + completed_at: string; + /** @description List of patterns that were updated. This will be empty for normal backfill scans or custom pattern updates */ + secret_types?: string[] | null; + /** @description If the scan was triggered by a custom pattern update, this will be the name of the pattern that was updated */ + custom_pattern_name?: string | null; + /** + * @description If the scan was triggered by a custom pattern update, this will be the scope of the pattern that was updated + * @enum {string|null} + */ + custom_pattern_scope?: "repository" | "organization" | "enterprise" | null; + repository?: components["schemas"]["repository-webhooks"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + sender?: components["schemas"]["simple-user"]; + }; /** security_advisory published event */ "webhook-security-advisory-published": { /** @enum {string} */ @@ -82850,6 +83582,7 @@ export interface components { reason: "expired_key" | "not_signing_key" | "gpgverify_error" | "gpgverify_unavailable" | "unsigned" | "unknown_signature_type" | "no_user" | "unverified_email" | "bad_email" | "unknown_key" | "malformed_signature" | "invalid" | "valid" | "bad_cert" | "ocsp_pending"; signature: string | null; verified: boolean; + verified_at?: string | null; }; }; /** User */ @@ -86045,8 +86778,8 @@ export interface components { "application/json": components["schemas"]["basic-error"]; }; }; - /** @description Internal Error */ - internal_error: { + /** @description Conflict */ + conflict: { headers: { [name: string]: unknown; }; @@ -86054,14 +86787,12 @@ export interface components { "application/json": components["schemas"]["basic-error"]; }; }; - /** @description Copilot Usage Merics API setting is disabled at the organization or enterprise level. */ - usage_metrics_api_disabled: { + /** @description A header with no content is returned. */ + no_content: { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["basic-error"]; - }; + content?: never; }; /** @description Service unavailable */ service_unavailable: { @@ -86102,8 +86833,17 @@ export interface components { "application/json": components["schemas"]["basic-error"]; }; }; - /** @description Conflict */ - conflict: { + /** @description Billing usage report response for an organization */ + billing_usage_report_org: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["billing-usage-report"]; + }; + }; + /** @description Internal Error */ + internal_error: { headers: { [name: string]: unknown; }; @@ -86148,12 +86888,14 @@ export interface components { }; }; }; - /** @description A header with no content is returned. */ - no_content: { + /** @description Copilot Usage Merics API setting is disabled at the organization or enterprise level. */ + usage_metrics_api_disabled: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["basic-error"]; + }; }; /** @description The value of `per_page` multiplied by `page` cannot be greater than 10000. */ package_es_list_error: { @@ -86198,6 +86940,24 @@ export interface components { "application/json": components["schemas"]["basic-error"]; }; }; + /** @description Bad Request */ + code_scanning_bad_request: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + /** @description Response if the repository is archived, if GitHub Advanced Security is not enabled for this repository or if rate limit is exceeded */ + code_scanning_autofix_create_forbidden: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; /** @description Found */ found: { headers: { @@ -86271,6 +87031,8 @@ export interface components { "classroom-id": number; /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: string; + /** @description The unique identifier of the code security configuration. */ + "configuration-id": number; /** @description A comma-separated list of states. If specified, only alerts with these states will be returned. * * Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` */ @@ -86301,9 +87063,7 @@ export interface components { "pagination-last": number; /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ "secret-scanning-alert-state": "open" | "resolved"; - /** @description A comma-separated list of secret types to return. By default all secret types are returned. - * See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" - * for a complete list of secret types. */ + /** @description A comma-separated list of secret types to return. All default secret patterns are returned. To return experimental patterns, pass the token name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. */ "secret-scanning-alert-secret-type": string; /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ "secret-scanning-alert-resolution": string; @@ -86315,10 +87075,6 @@ export interface components { "secret-scanning-alert-publicly-leaked": boolean; /** @description A boolean value representing whether or not to filter alerts by the multi-repo tag being present. */ "secret-scanning-alert-multi-repo": boolean; - /** @description The slug of the enterprise team name. */ - "enterprise-team-slug": string; - /** @description The slug of the team name. */ - "team-slug": string; /** @description The unique identifier of the gist. */ "gist-id": string; /** @description The unique identifier of the comment. */ @@ -86347,6 +87103,14 @@ export interface components { "since-org": number; /** @description The organization name. The name is not case sensitive. */ org: string; + /** @description If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2024`. Default value is the current year. */ + "billing-usage-report-year": number; + /** @description If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. */ + "billing-usage-report-month": number; + /** @description If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. */ + "billing-usage-report-day": number; + /** @description If specified, only return results for a single hour. The value of `hour` is an integer between `0` and `23`. */ + "billing-usage-report-hour": number; /** @description The unique identifier of the repository. */ "repository-id": number; /** @description Only return runner groups that are allowed to be used by this repository. */ @@ -86369,26 +87133,30 @@ export interface components { "tool-name": components["schemas"]["code-scanning-analysis-tool-name"]; /** @description The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both. */ "tool-guid": components["schemas"]["code-scanning-analysis-tool-guid"]; - /** @description The unique identifier of the code security configuration. */ - "configuration-id": number; /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ "hook-id": number; /** @description The type of the actor */ - "api-insights-actor-type": "installations" | "classic_pats" | "fine_grained_pats" | "oauth_apps" | "github_apps_user_to_server"; + "api-insights-actor-type": "installation" | "classic_pat" | "fine_grained_pat" | "oauth_app" | "github_app_user_to_server"; /** @description The ID of the actor */ "api-insights-actor-id": number; - /** @description The minimum timestamp to query for stats */ + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ "api-insights-min-timestamp": string; - /** @description The maximum timestamp to query for stats */ + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ "api-insights-max-timestamp": string; /** @description The property to sort the results by. */ "api-insights-route-stats-sort": ("last_rate_limited_timestamp" | "last_request_timestamp" | "rate_limited_request_count" | "http_method" | "api_route" | "total_request_count")[]; + /** @description Providing a substring will filter results where the API route contains the substring. This is a case-insensitive search. */ + "api-insights-api-route-substring": string; /** @description The property to sort the results by. */ "api-insights-sort": ("last_rate_limited_timestamp" | "last_request_timestamp" | "rate_limited_request_count" | "subject_name" | "total_request_count")[]; + /** @description Providing a substring will filter results where the subject name contains the substring. This is a case-insensitive search. */ + "api-insights-subject-name-substring": string; /** @description The ID of the user to query for stats */ "api-insights-user-id": string; /** @description The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) */ "api-insights-timestamp-increment": string; + /** @description Providing a substring will filter results where the actor name contains the substring. This is a case-insensitive search. */ + "api-insights-actor-name-substring": string; /** @description The unique identifier of the invitation. */ "invitation-id": number; /** @description The name of the codespace. */ @@ -86397,6 +87165,8 @@ export interface components { "migration-id": number; /** @description repo_name parameter */ "repo-name": string; + /** @description The slug of the team name. */ + "team-slug": string; /** @description The unique identifier of the role. */ "role-id": number; /** @description The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -86433,8 +87203,8 @@ export interface components { "ruleset-targets": string; /** @description The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. */ "ref-in-query": string; - /** @description The name of the repository to filter on. When specified, only rule evaluations from this repository will be returned. */ - "repository-name-in-query": number; + /** @description The name of the repository to filter on. */ + "repository-name-in-query": string; /** @description The time period to filter by. * * For example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for insights that occurred in the past 7 days (168 hours). */ @@ -87519,13 +88289,15 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; - "copilot/list-copilot-seats-for-enterprise": { + "code-security/get-configurations-for-enterprise": { parameters: { query?: { - /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - page?: components["parameters"]["page"]; /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: number; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + before?: components["parameters"]["pagination-before"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + after?: components["parameters"]["pagination-after"]; }; header?: never; path: { @@ -87539,39 +88311,164 @@ export interface operations { /** @description Response */ 200: { headers: { - Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": { - /** @description The total number of Copilot seats the enterprise is being billed for. Users with access through multiple organizations or enterprise teams are only counted once. */ - total_seats?: number; - seats?: components["schemas"]["copilot-seat-details"][]; + "application/json": components["schemas"]["code-security-configuration"][]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "code-security/create-configuration-for-enterprise": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + enterprise: components["parameters"]["enterprise"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description The name of the code security configuration. Must be unique within the enterprise. */ + name: string; + /** @description A description of the code security configuration */ + description: string; + /** + * @description The enablement status of GitHub Advanced Security + * @default disabled + * @enum {string} + */ + advanced_security?: "enabled" | "disabled"; + /** + * @description The enablement status of Dependency Graph + * @default enabled + * @enum {string} + */ + dependency_graph?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Automatic dependency submission + * @default disabled + * @enum {string} + */ + dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for Automatic dependency submission */ + dependency_graph_autosubmit_action_options?: { + /** + * @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. + * @default false + */ + labeled_runners?: boolean; }; + /** + * @description The enablement status of Dependabot alerts + * @default disabled + * @enum {string} + */ + dependabot_alerts?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot security updates + * @default disabled + * @enum {string} + */ + dependabot_security_updates?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of code scanning default setup + * @default disabled + * @enum {string} + */ + code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; + code_scanning_default_setup_options?: components["schemas"]["code-scanning-default-setup-options"]; + /** + * @description The enablement status of secret scanning + * @default disabled + * @enum {string} + */ + secret_scanning?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning push protection + * @default disabled + * @enum {string} + */ + secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning validity checks + * @default disabled + * @enum {string} + */ + secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning non provider patterns + * @default disabled + * @enum {string} + */ + secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of private vulnerability reporting + * @default disabled + * @enum {string} + */ + private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; + /** + * @description The enforcement status for a security configuration + * @default enforced + * @enum {string} + */ + enforcement?: "enforced" | "unenforced"; }; }; - 401: components["responses"]["requires_authentication"]; + }; + responses: { + /** @description Successfully created code security configuration */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["code-security-configuration"]; + }; + }; + 400: components["responses"]["bad_request"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; }; }; - "copilot/copilot-metrics-for-enterprise": { + "code-security/get-default-configurations-for-enterprise": { parameters: { - query?: { - /** @description Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago. */ - since?: string; - /** @description Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed. */ - until?: string; - /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - page?: components["parameters"]["page"]; - /** @description The number of days of metrics to display per page (max 28). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - per_page?: number; + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + enterprise: components["parameters"]["enterprise"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["code-security-default-configurations"]; + }; }; + }; + }; + "code-security/get-single-configuration-for-enterprise": { + parameters: { + query?: never; header?: never; path: { /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description The unique identifier of the code security configuration. */ + configuration_id: components["parameters"]["configuration-id"]; }; cookie?: never; }; @@ -87583,31 +88480,233 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["copilot-usage-metrics-day"][]; + "application/json": components["schemas"]["code-security-configuration"]; }; }; + 304: components["responses"]["not_modified"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - 422: components["responses"]["usage_metrics_api_disabled"]; - 500: components["responses"]["internal_error"]; }; }; - "copilot/usage-metrics-for-enterprise": { + "code-security/delete-configuration-for-enterprise": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The unique identifier of the code security configuration. */ + configuration_id: components["parameters"]["configuration-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 204: components["responses"]["no_content"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + }; + }; + "code-security/update-enterprise-configuration": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The unique identifier of the code security configuration. */ + configuration_id: components["parameters"]["configuration-id"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description The name of the code security configuration. Must be unique across the enterprise. */ + name?: string; + /** @description A description of the code security configuration */ + description?: string; + /** + * @description The enablement status of GitHub Advanced Security. Must be set to enabled if you want to enable any GHAS settings. + * @enum {string} + */ + advanced_security?: "enabled" | "disabled"; + /** + * @description The enablement status of Dependency Graph + * @enum {string} + */ + dependency_graph?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Automatic dependency submission + * @enum {string} + */ + dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for Automatic dependency submission */ + dependency_graph_autosubmit_action_options?: { + /** @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. */ + labeled_runners?: boolean; + }; + /** + * @description The enablement status of Dependabot alerts + * @enum {string} + */ + dependabot_alerts?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot security updates + * @enum {string} + */ + dependabot_security_updates?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of code scanning default setup + * @enum {string} + */ + code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; + code_scanning_default_setup_options?: components["schemas"]["code-scanning-default-setup-options"]; + /** + * @description The enablement status of secret scanning + * @enum {string} + */ + secret_scanning?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning push protection + * @enum {string} + */ + secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning validity checks + * @enum {string} + */ + secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning non-provider patterns + * @enum {string} + */ + secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of private vulnerability reporting + * @enum {string} + */ + private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; + /** + * @description The enforcement status for a security configuration + * @enum {string} + */ + enforcement?: "enforced" | "unenforced"; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["code-security-configuration"]; + }; + }; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + }; + }; + "code-security/attach-enterprise-configuration": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The unique identifier of the code security configuration. */ + configuration_id: components["parameters"]["configuration-id"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** + * @description The type of repositories to attach the configuration to. `selected` means the configuration will be attached to only the repositories specified by `selected_repository_ids` + * @enum {string} + */ + scope: "all" | "all_without_configurations"; + }; + }; + }; + responses: { + 202: components["responses"]["accepted"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + }; + }; + "code-security/set-configuration-as-default-for-enterprise": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The unique identifier of the code security configuration. */ + configuration_id: components["parameters"]["configuration-id"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** + * @description Specify which types of repository this security configuration should be applied to by default. + * @enum {string} + */ + default_for_new_repos?: "all" | "none" | "private_and_internal" | "public"; + }; + }; + }; + responses: { + /** @description Default successfully changed. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * @description Specifies which types of repository this security configuration is applied to by default. + * @enum {string} + */ + default_for_new_repos?: "all" | "none" | "private_and_internal" | "public"; + configuration?: components["schemas"]["code-security-configuration"]; + }; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "code-security/get-repositories-for-enterprise-configuration": { parameters: { query?: { - /** @description Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago. */ - since?: string; - /** @description Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed. */ - until?: string; - /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - page?: components["parameters"]["page"]; - /** @description The number of days of metrics to display per page (max 28). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: number; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + before?: components["parameters"]["pagination-before"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + after?: components["parameters"]["pagination-after"]; + /** @description A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned. + * + * Can be: `all`, `attached`, `attaching`, `removed`, `enforced`, `failed`, `updating`, `removed_by_enterprise` */ + status?: string; }; header?: never; path: { /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description The unique identifier of the code security configuration. */ + configuration_id: components["parameters"]["configuration-id"]; }; cookie?: never; }; @@ -87619,13 +88718,11 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["copilot-usage-metrics"][]; + "application/json": components["schemas"]["code-security-configuration-repositories"][]; }; }; - 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; }; }; "dependabot/list-alerts-for-enterprise": { @@ -87697,9 +88794,7 @@ export interface operations { query?: { /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ state?: components["parameters"]["secret-scanning-alert-state"]; - /** @description A comma-separated list of secret types to return. By default all secret types are returned. - * See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" - * for a complete list of secret types. */ + /** @description A comma-separated list of secret types to return. All default secret patterns are returned. To return experimental patterns, pass the token name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. */ secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ resolution?: components["parameters"]["secret-scanning-alert-resolution"]; @@ -87743,82 +88838,6 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - "copilot/copilot-metrics-for-enterprise-team": { - parameters: { - query?: { - /** @description Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago. */ - since?: string; - /** @description Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed. */ - until?: string; - /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - page?: components["parameters"]["page"]; - /** @description The number of days of metrics to display per page (max 28). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - per_page?: number; - }; - header?: never; - path: { - /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - /** @description The slug of the enterprise team name. */ - team_slug: components["parameters"]["enterprise-team-slug"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["copilot-usage-metrics-day"][]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["usage_metrics_api_disabled"]; - 500: components["responses"]["internal_error"]; - }; - }; - "copilot/usage-metrics-for-enterprise-team": { - parameters: { - query?: { - /** @description Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago. */ - since?: string; - /** @description Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed. */ - until?: string; - /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - page?: components["parameters"]["page"]; - /** @description The number of days of metrics to display per page (max 28). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - per_page?: number; - }; - header?: never; - path: { - /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - /** @description The slug of the team name. */ - team_slug: components["parameters"]["team-slug"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["copilot-usage-metrics"][]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; - }; - }; "activity/list-public-events": { parameters: { query?: { @@ -89271,6 +90290,34 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; + "billing/get-github-billing-usage-report-org": { + parameters: { + query?: { + /** @description If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2024`. Default value is the current year. */ + year?: components["parameters"]["billing-usage-report-year"]; + /** @description If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. */ + month?: components["parameters"]["billing-usage-report-month"]; + /** @description If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. */ + day?: components["parameters"]["billing-usage-report-day"]; + /** @description If specified, only return results for a single hour. The value of `hour` is an integer between `0` and `23`. */ + hour?: components["parameters"]["billing-usage-report-hour"]; + }; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["billing_usage_report_org"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 500: components["responses"]["internal_error"]; + 503: components["responses"]["service_unavailable"]; + }; + }; "orgs/get": { parameters: { query?: never; @@ -91166,6 +92213,7 @@ export interface operations { }; }; repository_id?: number; + bundle_url?: string; }[]; }; }; @@ -91421,6 +92469,7 @@ export interface operations { * @enum {string} */ code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; + code_scanning_default_setup_options?: components["schemas"]["code-scanning-default-setup-options"]; /** * @description The enablement status of secret scanning * @default disabled @@ -91646,6 +92695,7 @@ export interface operations { * @enum {string} */ code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; + code_scanning_default_setup_options?: components["schemas"]["code-scanning-default-setup-options"]; /** * @description The enablement status of secret scanning * @enum {string} @@ -93373,10 +94423,10 @@ export interface operations { "api-insights/get-route-stats-by-actor": { parameters: { query: { - /** @description The minimum timestamp to query for stats */ + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ min_timestamp: components["parameters"]["api-insights-min-timestamp"]; - /** @description The maximum timestamp to query for stats */ - max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ @@ -93385,6 +94435,8 @@ export interface operations { direction?: components["parameters"]["direction"]; /** @description The property to sort the results by. */ sort?: components["parameters"]["api-insights-route-stats-sort"]; + /** @description Providing a substring will filter results where the API route contains the substring. This is a case-insensitive search. */ + api_route_substring?: components["parameters"]["api-insights-api-route-substring"]; }; header?: never; path: { @@ -93413,10 +94465,10 @@ export interface operations { "api-insights/get-subject-stats": { parameters: { query: { - /** @description The minimum timestamp to query for stats */ + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ min_timestamp: components["parameters"]["api-insights-min-timestamp"]; - /** @description The maximum timestamp to query for stats */ - max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ @@ -93425,6 +94477,8 @@ export interface operations { direction?: components["parameters"]["direction"]; /** @description The property to sort the results by. */ sort?: components["parameters"]["api-insights-sort"]; + /** @description Providing a substring will filter results where the subject name contains the substring. This is a case-insensitive search. */ + subject_name_substring?: components["parameters"]["api-insights-subject-name-substring"]; }; header?: never; path: { @@ -93449,10 +94503,10 @@ export interface operations { "api-insights/get-summary-stats": { parameters: { query: { - /** @description The minimum timestamp to query for stats */ + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ min_timestamp: components["parameters"]["api-insights-min-timestamp"]; - /** @description The maximum timestamp to query for stats */ - max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; }; header?: never; path: { @@ -93477,10 +94531,10 @@ export interface operations { "api-insights/get-summary-stats-by-user": { parameters: { query: { - /** @description The minimum timestamp to query for stats */ + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ min_timestamp: components["parameters"]["api-insights-min-timestamp"]; - /** @description The maximum timestamp to query for stats */ - max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; }; header?: never; path: { @@ -93507,10 +94561,10 @@ export interface operations { "api-insights/get-summary-stats-by-actor": { parameters: { query: { - /** @description The minimum timestamp to query for stats */ + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ min_timestamp: components["parameters"]["api-insights-min-timestamp"]; - /** @description The maximum timestamp to query for stats */ - max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; }; header?: never; path: { @@ -93539,10 +94593,10 @@ export interface operations { "api-insights/get-time-stats": { parameters: { query: { - /** @description The minimum timestamp to query for stats */ + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ min_timestamp: components["parameters"]["api-insights-min-timestamp"]; - /** @description The maximum timestamp to query for stats */ - max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; /** @description The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) */ timestamp_increment: components["parameters"]["api-insights-timestamp-increment"]; }; @@ -93569,10 +94623,10 @@ export interface operations { "api-insights/get-time-stats-by-user": { parameters: { query: { - /** @description The minimum timestamp to query for stats */ + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ min_timestamp: components["parameters"]["api-insights-min-timestamp"]; - /** @description The maximum timestamp to query for stats */ - max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; /** @description The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) */ timestamp_increment: components["parameters"]["api-insights-timestamp-increment"]; }; @@ -93601,10 +94655,10 @@ export interface operations { "api-insights/get-time-stats-by-actor": { parameters: { query: { - /** @description The minimum timestamp to query for stats */ + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ min_timestamp: components["parameters"]["api-insights-min-timestamp"]; - /** @description The maximum timestamp to query for stats */ - max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; /** @description The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) */ timestamp_increment: components["parameters"]["api-insights-timestamp-increment"]; }; @@ -93635,10 +94689,10 @@ export interface operations { "api-insights/get-user-stats": { parameters: { query: { - /** @description The minimum timestamp to query for stats */ + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ min_timestamp: components["parameters"]["api-insights-min-timestamp"]; - /** @description The maximum timestamp to query for stats */ - max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ @@ -93647,6 +94701,8 @@ export interface operations { direction?: components["parameters"]["direction"]; /** @description The property to sort the results by. */ sort?: components["parameters"]["api-insights-sort"]; + /** @description Providing a substring will filter results where the actor name contains the substring. This is a case-insensitive search. */ + actor_name_substring?: components["parameters"]["api-insights-actor-name-substring"]; }; header?: never; path: { @@ -95515,6 +96571,223 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; + "private-registries/list-org-private-registries": { + parameters: { + query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + page?: components["parameters"]["page"]; + }; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": { + total_count: number; + configurations: components["schemas"]["org-private-registry-configuration"][]; + }; + }; + }; + 400: components["responses"]["bad_request"]; + 404: components["responses"]["not_found"]; + }; + }; + "private-registries/create-org-private-registry": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** + * @description The registry type. + * @enum {string} + */ + registry_type: "maven_repository"; + /** @description The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication. */ + username?: string | null; + /** @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint. */ + encrypted_value: string; + /** @description The ID of the key you used to encrypt the secret. */ + key_id: string; + /** + * @description Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry. + * @enum {string} + */ + visibility: "all" | "private" | "selected"; + /** @description An array of repository IDs that can access the organization private registry. You can only provide a list of repository IDs when `visibility` is set to `selected`. You can manage the list of selected repositories using the [Update a private registry for an organization](https://docs.github.com/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization) endpoint. This field should be omitted if `visibility` is set to `all` or `private`. */ + selected_repository_ids?: number[]; + }; + }; + }; + responses: { + /** @description The organization private registry configuration */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["org-private-registry-configuration-with-selected-repositories"]; + }; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "private-registries/get-org-public-key": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * @description The identifier for the key. + * @example 012345678912345678 + */ + key_id: string; + /** + * @description The Base64 encoded public key. + * @example 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 + */ + key: string; + }; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + "private-registries/get-org-private-registry": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The name of the secret. */ + secret_name: components["parameters"]["secret-name"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description The specified private registry configuration for the organization */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["org-private-registry-configuration"]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + "private-registries/delete-org-private-registry": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The name of the secret. */ + secret_name: components["parameters"]["secret-name"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 400: components["responses"]["bad_request"]; + 404: components["responses"]["not_found"]; + }; + }; + "private-registries/update-org-private-registry": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The name of the secret. */ + secret_name: components["parameters"]["secret-name"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** + * @description The registry type. + * @enum {string} + */ + registry_type?: "maven_repository"; + /** @description The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication. */ + username?: string | null; + /** @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint. */ + encrypted_value?: string; + /** @description The ID of the key you used to encrypt the secret. */ + key_id?: string; + /** + * @description Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry. + * @enum {string} + */ + visibility?: "all" | "private" | "selected"; + /** @description An array of repository IDs that can access the organization private registry. You can only provide a list of repository IDs when `visibility` is set to `selected`. This field should be omitted if `visibility` is set to `all` or `private`. */ + selected_repository_ids?: number[]; + }; + }; + }; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; "projects/list-for-org": { parameters: { query?: { @@ -95682,23 +96955,7 @@ export interface operations { }; requestBody: { content: { - "application/json": { - /** - * @description The type of the value for the property - * @example single_select - * @enum {string} - */ - value_type: "string" | "single_select" | "multi_select" | "true_false"; - /** @description Whether the property is required. */ - required?: boolean; - /** @description Default value of the property */ - default_value?: (string | string[]) | null; - /** @description Short description of the property */ - description?: string | null; - /** @description An ordered list of the allowed values of the property. - * The property can have up to 200 allowed values. */ - allowed_values?: string[] | null; - }; + "application/json": components["schemas"]["custom-property-set-payload"]; }; }; responses: { @@ -96155,7 +97412,7 @@ export interface operations { * @default branch * @enum {string} */ - target?: "branch" | "tag" | "push"; + target?: "branch" | "tag" | "push" | "repository"; enforcement: components["schemas"]["repository-rule-enforcement"]; /** @description The actors that can bypass the rules in this ruleset */ bypass_actors?: components["schemas"]["repository-ruleset-bypass-actor"][]; @@ -96184,7 +97441,7 @@ export interface operations { query?: { /** @description The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. */ ref?: components["parameters"]["ref-in-query"]; - /** @description The name of the repository to filter on. When specified, only rule evaluations from this repository will be returned. */ + /** @description The name of the repository to filter on. */ repository_name?: components["parameters"]["repository-name-in-query"]; /** @description The time period to filter by. * @@ -96300,7 +97557,7 @@ export interface operations { * @description The target of the ruleset * @enum {string} */ - target?: "branch" | "tag" | "push"; + target?: "branch" | "tag" | "push" | "repository"; enforcement?: components["schemas"]["repository-rule-enforcement"]; /** @description The actors that can bypass the rules in this ruleset */ bypass_actors?: components["schemas"]["repository-ruleset-bypass-actor"][]; @@ -96354,9 +97611,7 @@ export interface operations { query?: { /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ state?: components["parameters"]["secret-scanning-alert-state"]; - /** @description A comma-separated list of secret types to return. By default all secret types are returned. - * See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" - * for a complete list of secret types. */ + /** @description A comma-separated list of secret types to return. All default secret patterns are returned. To return experimental patterns, pass the token name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. */ secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ resolution?: components["parameters"]["secret-scanning-alert-resolution"]; @@ -101375,6 +102630,7 @@ export interface operations { }; }; repository_id?: number; + bundle_url?: string; }[]; }; }; @@ -103463,6 +104719,126 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; + "code-scanning/get-autofix": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The account owner of the repository. The name is not case sensitive. */ + owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ + repo: components["parameters"]["repo"]; + /** @description The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */ + alert_number: components["parameters"]["alert-number"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["code-scanning-autofix"]; + }; + }; + 400: components["responses"]["code_scanning_bad_request"]; + 403: components["responses"]["code_scanning_forbidden_read"]; + 404: components["responses"]["not_found"]; + 503: components["responses"]["service_unavailable"]; + }; + }; + "code-scanning/create-autofix": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The account owner of the repository. The name is not case sensitive. */ + owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ + repo: components["parameters"]["repo"]; + /** @description The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */ + alert_number: components["parameters"]["alert-number"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["code-scanning-autofix"]; + }; + }; + /** @description Accepted */ + 202: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["code-scanning-autofix"]; + }; + }; + 400: components["responses"]["code_scanning_bad_request"]; + 403: components["responses"]["code_scanning_autofix_create_forbidden"]; + 404: components["responses"]["not_found"]; + /** @description Unprocessable Entity */ + 422: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 503: components["responses"]["service_unavailable"]; + }; + }; + "code-scanning/commit-autofix": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The account owner of the repository. The name is not case sensitive. */ + owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ + repo: components["parameters"]["repo"]; + /** @description The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */ + alert_number: components["parameters"]["alert-number"]; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": components["schemas"]["code-scanning-autofix-commits"]; + }; + }; + responses: { + /** @description Created */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["code-scanning-autofix-commits-response"]; + }; + }; + 400: components["responses"]["code_scanning_bad_request"]; + 403: components["responses"]["code_scanning_forbidden_write"]; + 404: components["responses"]["not_found"]; + /** @description Unprocessable Entity */ + 422: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 503: components["responses"]["service_unavailable"]; + }; + }; "code-scanning/list-alert-instances": { parameters: { query?: { @@ -109679,6 +111055,163 @@ export interface operations { }; }; }; + "issues/remove-sub-issue": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The account owner of the repository. The name is not case sensitive. */ + owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ + repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ + issue_number: components["parameters"]["issue-number"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description The sub-issue to remove */ + sub_issue_id: number; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + /** @example https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue */ + Location?: string; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["issue"]; + }; + }; + 400: components["responses"]["bad_request"]; + 404: components["responses"]["not_found"]; + }; + }; + "issues/list-sub-issues": { + parameters: { + query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + page?: components["parameters"]["page"]; + }; + header?: never; + path: { + /** @description The account owner of the repository. The name is not case sensitive. */ + owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ + repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ + issue_number: components["parameters"]["issue-number"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["issue"][]; + }; + }; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; + }; + }; + "issues/add-sub-issue": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The account owner of the repository. The name is not case sensitive. */ + owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ + repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ + issue_number: components["parameters"]["issue-number"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description The sub-issue to add */ + sub_issue_id: number; + /** @description Option that, when true, instructs the operation to replace the sub-issues current parent issue */ + replace_parent?: boolean; + }; + }; + }; + responses: { + /** @description Response */ + 201: { + headers: { + /** @example https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1 */ + Location?: string; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["issue"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "issues/reprioritize-sub-issue": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The account owner of the repository. The name is not case sensitive. */ + owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ + repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ + issue_number: components["parameters"]["issue-number"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description The id of the sub-issue to reprioritize */ + sub_issue_id: number; + /** @description The id of the sub-issue to be prioritized after (either positional argument after OR before should be specified). */ + after_id?: number; + /** @description The id of the sub-issue to be prioritized before (either positional argument after OR before should be specified). */ + before_id?: number; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["issue"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed_simple"]; + 503: components["responses"]["service_unavailable"]; + }; + }; "issues/list-events-for-timeline": { parameters: { query?: { @@ -113291,9 +114824,7 @@ export interface operations { query?: { /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ state?: components["parameters"]["secret-scanning-alert-state"]; - /** @description A comma-separated list of secret types to return. By default all secret types are returned. - * See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" - * for a complete list of secret types. */ + /** @description A comma-separated list of secret types to return. All default secret patterns are returned. To return experimental patterns, pass the token name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. */ secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ resolution?: components["parameters"]["secret-scanning-alert-resolution"]; @@ -113534,6 +115065,39 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; + "secret-scanning/get-scan-history": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The account owner of the repository. The name is not case sensitive. */ + owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ + repo: components["parameters"]["repo"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["secret-scanning-scan-history"]; + }; + }; + /** @description Repository does not have GitHub Advanced Security or secret scanning enabled */ + 404: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 503: components["responses"]["service_unavailable"]; + }; + }; "security-advisories/list-repository-advisories": { parameters: { query?: { @@ -119189,6 +120753,7 @@ export interface operations { attestations?: { bundle?: components["schemas"]["sigstore-bundle-0"]; repository_id?: number; + bundle_url?: string; }[]; }; }; diff --git a/packages/openapi-fetch/test/examples/schemas/stripe.d.ts b/packages/openapi-fetch/test/examples/schemas/stripe.d.ts index f8237c017..a1d3a6337 100644 --- a/packages/openapi-fetch/test/examples/schemas/stripe.d.ts +++ b/packages/openapi-fetch/test/examples/schemas/stripe.d.ts @@ -872,7 +872,7 @@ export interface paths { }; /** * Retrieve the credit balance summary for a customer - * @description

Retrieves the credit balance summary for a customer

+ * @description

Retrieves the credit balance summary for a customer.

*/ get: operations["GetBillingCreditBalanceSummary"]; put?: never; @@ -892,7 +892,7 @@ export interface paths { }; /** * List credit balance transactions - * @description

Retrieve a list of credit balance transactions

+ * @description

Retrieve a list of credit balance transactions.

*/ get: operations["GetBillingCreditBalanceTransactions"]; put?: never; @@ -912,7 +912,7 @@ export interface paths { }; /** * Retrieve a credit balance transaction - * @description

Retrieves a credit balance transaction

+ * @description

Retrieves a credit balance transaction.

*/ get: operations["GetBillingCreditBalanceTransactionsId"]; put?: never; @@ -938,7 +938,7 @@ export interface paths { put?: never; /** * Create a credit grant - * @description

Creates a credit grant

+ * @description

Creates a credit grant.

*/ post: operations["PostBillingCreditGrants"]; delete?: never; @@ -956,13 +956,13 @@ export interface paths { }; /** * Retrieve a credit grant - * @description

Retrieves a credit grant

+ * @description

Retrieves a credit grant.

*/ get: operations["GetBillingCreditGrantsId"]; put?: never; /** * Update a credit grant - * @description

Updates a credit grant

+ * @description

Updates a credit grant.

*/ post: operations["PostBillingCreditGrantsId"]; delete?: never; @@ -1022,7 +1022,7 @@ export interface paths { put?: never; /** * Create a billing meter event adjustment - * @description

Creates a billing meter event adjustment

+ * @description

Creates a billing meter event adjustment.

*/ post: operations["PostBillingMeterEventAdjustments"]; delete?: never; @@ -1042,7 +1042,7 @@ export interface paths { put?: never; /** * Create a billing meter event - * @description

Creates a billing meter event

+ * @description

Creates a billing meter event.

*/ post: operations["PostBillingMeterEvents"]; delete?: never; @@ -1066,7 +1066,7 @@ export interface paths { put?: never; /** * Create a billing meter - * @description

Creates a billing meter

+ * @description

Creates a billing meter.

*/ post: operations["PostBillingMeters"]; delete?: never; @@ -1084,13 +1084,13 @@ export interface paths { }; /** * Retrieve a billing meter - * @description

Retrieves a billing meter given an ID

+ * @description

Retrieves a billing meter given an ID.

*/ get: operations["GetBillingMetersId"]; put?: never; /** * Update a billing meter - * @description

Updates a billing meter

+ * @description

Updates a billing meter.

*/ post: operations["PostBillingMetersId"]; delete?: never; @@ -1110,7 +1110,7 @@ export interface paths { put?: never; /** * Deactivate a billing meter - * @description

Deactivates a billing meter

+ * @description

When a meter is deactivated, no more meter events will be accepted for this meter. You can’t attach a deactivated meter to a price.

*/ post: operations["PostBillingMetersIdDeactivate"]; delete?: never; @@ -1150,7 +1150,7 @@ export interface paths { put?: never; /** * Reactivate a billing meter - * @description

Reactivates a billing meter

+ * @description

When a meter is reactivated, events for this meter can be accepted and you can attach the meter to a price.

*/ post: operations["PostBillingMetersIdReactivate"]; delete?: never; @@ -8901,7 +8901,10 @@ export interface components { account_annual_revenue: { /** @description A non-negative integer representing the amount in the [smallest currency unit](/currencies#zero-decimal). */ amount?: number | null; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency?: string | null; /** @description The close-out date of the preceding fiscal year in ISO 8601 format. E.g. 2023-12-31 for the 31st of December, 2023. */ fiscal_year_end?: string | null; @@ -9222,7 +9225,7 @@ export interface components { alternatives?: components["schemas"]["account_requirements_alternative"][] | null; /** * Format: unix-time - * @description Date on which `future_requirements` merges with the main `requirements` hash and `future_requirements` becomes empty. After the transition, `currently_due` requirements may immediately become `past_due`, but the account may also be given a grace period depending on the capability's enablement state prior to transitioning. + * @description Date on which `future_requirements` becomes the main `requirements` hash and `future_requirements` becomes empty. After the transition, `currently_due` requirements may immediately become `past_due`, but the account may also be given a grace period depending on the capability's enablement state prior to transitioning. */ current_deadline?: number | null; /** @description Fields that need to be collected to keep the capability enabled. If not collected by `future_requirements[current_deadline]`, these fields will transition to the main `requirements` hash. */ @@ -9234,7 +9237,7 @@ export interface components { disabled_reason?: "other" | "paused.inactivity" | "pending.onboarding" | "pending.review" | "platform_disabled" | "platform_paused" | "rejected.inactivity" | "rejected.other" | "rejected.unsupported_business" | "requirements.fields_needed" | null; /** @description Fields that are `currently_due` and need to be collected again because validation or verification failed. */ errors: components["schemas"]["account_requirements_error"][]; - /** @description Fields that need to be collected assuming all volume thresholds are reached. As they become required, they appear in `currently_due` as well. */ + /** @description Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well. */ eventually_due: string[]; /** @description Fields that weren't collected by `requirements.current_deadline`. These fields need to be collected to enable the capability on the account. New fields will never appear here; `future_requirements.past_due` will always be a subset of `requirements.past_due`. */ past_due: string[]; @@ -9259,7 +9262,7 @@ export interface components { disabled_reason?: "other" | "paused.inactivity" | "pending.onboarding" | "pending.review" | "platform_disabled" | "platform_paused" | "rejected.inactivity" | "rejected.other" | "rejected.unsupported_business" | "requirements.fields_needed" | null; /** @description Fields that are `currently_due` and need to be collected again because validation or verification failed. */ errors: components["schemas"]["account_requirements_error"][]; - /** @description Fields that need to be collected assuming all volume thresholds are reached. As they become required, they appear in `currently_due` as well, and `current_deadline` becomes set. */ + /** @description Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well, and `current_deadline` becomes set. */ eventually_due: string[]; /** @description Fields that weren't collected by `current_deadline`. These fields need to be collected to enable the capability on the account. */ past_due: string[]; @@ -9300,7 +9303,7 @@ export interface components { alternatives?: components["schemas"]["account_requirements_alternative"][] | null; /** * Format: unix-time - * @description Date on which `future_requirements` merges with the main `requirements` hash and `future_requirements` becomes empty. After the transition, `currently_due` requirements may immediately become `past_due`, but the account may also be given a grace period depending on its enablement state prior to transitioning. + * @description Date on which `future_requirements` becomes the main `requirements` hash and `future_requirements` becomes empty. After the transition, `currently_due` requirements may immediately become `past_due`, but the account may also be given a grace period depending on its enablement state prior to transitioning. */ current_deadline?: number | null; /** @description Fields that need to be collected to keep the account enabled. If not collected by `future_requirements[current_deadline]`, these fields will transition to the main `requirements` hash. */ @@ -9312,7 +9315,7 @@ export interface components { disabled_reason?: "action_required.requested_capabilities" | "listed" | "other" | "platform_paused" | "rejected.fraud" | "rejected.incomplete_verification" | "rejected.listed" | "rejected.other" | "rejected.platform_fraud" | "rejected.platform_other" | "rejected.platform_terms_of_service" | "rejected.terms_of_service" | "requirements.past_due" | "requirements.pending_verification" | "under_review" | null; /** @description Fields that are `currently_due` and need to be collected again because validation or verification failed. */ errors?: components["schemas"]["account_requirements_error"][] | null; - /** @description Fields that need to be collected assuming all volume thresholds are reached. As they become required, they appear in `currently_due` as well. */ + /** @description Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well. */ eventually_due?: string[] | null; /** @description Fields that weren't collected by `requirements.current_deadline`. These fields need to be collected to enable the capability on the account. New fields will never appear here; `future_requirements.past_due` will always be a subset of `requirements.past_due`. */ past_due?: string[] | null; @@ -9359,7 +9362,10 @@ export interface components { account_monthly_estimated_revenue: { /** @description A non-negative integer representing how much to charge in the [smallest currency unit](/currencies#zero-decimal). */ amount: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; }; /** AccountPaymentsSettings */ @@ -9401,7 +9407,7 @@ export interface components { disabled_reason?: "action_required.requested_capabilities" | "listed" | "other" | "platform_paused" | "rejected.fraud" | "rejected.incomplete_verification" | "rejected.listed" | "rejected.other" | "rejected.platform_fraud" | "rejected.platform_other" | "rejected.platform_terms_of_service" | "rejected.terms_of_service" | "requirements.past_due" | "requirements.pending_verification" | "under_review" | null; /** @description Fields that are `currently_due` and need to be collected again because validation or verification failed. */ errors?: components["schemas"]["account_requirements_error"][] | null; - /** @description Fields that need to be collected assuming all volume thresholds are reached. As they become required, they appear in `currently_due` as well, and `current_deadline` becomes set. */ + /** @description Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well, and `current_deadline` becomes set. */ eventually_due?: string[] | null; /** @description Fields that weren't collected by `current_deadline`. These fields need to be collected to enable the account. */ past_due?: string[] | null; @@ -9562,6 +9568,15 @@ export interface components { /** @description State, county, province, or region. */ state?: string | null; }; + /** amazon_pay_underlying_payment_method_funding_details */ + amazon_pay_underlying_payment_method_funding_details: { + card?: components["schemas"]["payment_method_details_passthrough_card"]; + /** + * @description funding type of the underlying payment method. + * @enum {string|null} + */ + type?: "card" | null; + }; /** APIErrors */ api_errors: { /** @description For card errors, the ID of the failed charge. */ @@ -9574,6 +9589,10 @@ export interface components { doc_url?: string; /** @description A human-readable message providing more details about the error. For card errors, these messages can be shown to your users. */ message?: string; + /** @description For card errors resulting from a card issuer decline, a 2 digit code which indicates the advice given to merchant by the card network on how to proceed with an error. */ + network_advice_code?: string; + /** @description For card errors resulting from a card issuer decline, a brand specific 2, 3, or 4 digit code which indicates the reason the authorization failed. */ + network_decline_code?: string; /** @description If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field. */ param?: string; payment_intent?: components["schemas"]["payment_intent"]; @@ -9640,7 +9659,10 @@ export interface components { * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ created: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description Polymorphic source of the application fee. Includes the ID of the object the application fee was created from. */ fee_source?: components["schemas"]["platform_earning_fee_source"] | null; @@ -9717,6 +9739,11 @@ export interface components { }; /** AutomaticTax */ automatic_tax: { + /** + * @description If Stripe disabled automatic tax, this enum describes why. + * @enum {string|null} + */ + disabled_reason?: "finalization_requires_location_inputs" | "finalization_system_error" | null; /** @description Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified [tax rates](https://stripe.com/docs/api/tax_rates), negative amounts, or `tax_behavior=unspecified`) cannot be added to automatic tax invoices. */ enabled: boolean; /** @description The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account. */ @@ -9763,7 +9790,10 @@ export interface components { balance_amount: { /** @description Balance amount. */ amount: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; source_types?: components["schemas"]["balance_amount_by_source_type"]; }; @@ -9780,7 +9810,10 @@ export interface components { balance_amount_net: { /** @description Balance amount. */ amount: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description Breakdown of balance by destination. */ net_available?: components["schemas"]["balance_net_available"][]; @@ -9819,7 +9852,10 @@ export interface components { * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ created: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ description?: string | null; @@ -9845,10 +9881,10 @@ export interface components { /** @description The transaction's net funds status in the Stripe balance, which are either `available` or `pending`. */ status: string; /** - * @description Transaction type: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `climate_order_purchase`, `climate_order_refund`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_outbound`, `obligation_reversal_inbound`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`. Learn more about [balance transaction types and what they represent](https://stripe.com/docs/reports/balance-transaction-types). To classify transactions for accounting purposes, consider `reporting_category` instead. + * @description Transaction type: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `climate_order_purchase`, `climate_order_refund`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_outbound`, `obligation_reversal_inbound`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `payout_minimum_balance_hold`, `payout_minimum_balance_release`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`. Learn more about [balance transaction types and what they represent](https://stripe.com/docs/reports/balance-transaction-types). To classify transactions for accounting purposes, consider `reporting_category` instead. * @enum {string} */ - type: "adjustment" | "advance" | "advance_funding" | "anticipation_repayment" | "application_fee" | "application_fee_refund" | "charge" | "climate_order_purchase" | "climate_order_refund" | "connect_collection_transfer" | "contribution" | "issuing_authorization_hold" | "issuing_authorization_release" | "issuing_dispute" | "issuing_transaction" | "obligation_outbound" | "obligation_reversal_inbound" | "payment" | "payment_failure_refund" | "payment_network_reserve_hold" | "payment_network_reserve_release" | "payment_refund" | "payment_reversal" | "payment_unreconciled" | "payout" | "payout_cancel" | "payout_failure" | "refund" | "refund_failure" | "reserve_transaction" | "reserved_funds" | "stripe_fee" | "stripe_fx_fee" | "tax_fee" | "topup" | "topup_reversal" | "transfer" | "transfer_cancel" | "transfer_failure" | "transfer_refund"; + type: "adjustment" | "advance" | "advance_funding" | "anticipation_repayment" | "application_fee" | "application_fee_refund" | "charge" | "climate_order_purchase" | "climate_order_refund" | "connect_collection_transfer" | "contribution" | "issuing_authorization_hold" | "issuing_authorization_release" | "issuing_dispute" | "issuing_transaction" | "obligation_outbound" | "obligation_reversal_inbound" | "payment" | "payment_failure_refund" | "payment_network_reserve_hold" | "payment_network_reserve_release" | "payment_refund" | "payment_reversal" | "payment_unreconciled" | "payout" | "payout_cancel" | "payout_failure" | "payout_minimum_balance_hold" | "payout_minimum_balance_release" | "refund" | "refund_failure" | "reserve_transaction" | "reserved_funds" | "stripe_fee" | "stripe_fx_fee" | "tax_fee" | "topup" | "topup_reversal" | "transfer" | "transfer_cancel" | "transfer_failure" | "transfer_refund"; }; /** * BankAccount @@ -9875,7 +9911,10 @@ export interface components { bank_name?: string | null; /** @description Two-letter ISO code representing the country the bank account is located in. */ country: string; - /** @description Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account. */ + /** + * Format: currency + * @description Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account. + */ currency: string; /** @description The ID of the customer that the bank account is associated with. */ customer?: (string | components["schemas"]["customer"] | components["schemas"]["deleted_customer"]) | null; @@ -10147,7 +10186,7 @@ export interface components { customer: string | components["schemas"]["customer"] | components["schemas"]["deleted_customer"]; /** * Format: unix-time - * @description The time when the billing credits become effective—when they're eligible for use. + * @description The time when the billing credits become effective-when they're eligible for use. */ effective_at?: number | null; /** @@ -10185,7 +10224,7 @@ export interface components { }; /** * BillingMeter - * @description A billing meter is a resource that allows you to track usage of a particular event. For example, you might create a billing meter to track the number of API calls made by a particular user. You can then attach the billing meter to a price and attach the price to a subscription to charge the user for the number of API calls they make. + * @description Meters specify how to aggregate meter events over a billing period. Meter events represent the actions that customers take in your system. Meters attach to prices and form the basis of the bill. * * Related guide: [Usage based billing](https://docs.stripe.com/billing/subscriptions/usage-based) */ @@ -10230,8 +10269,7 @@ export interface components { }; /** * BillingMeterEvent - * @description A billing meter event represents a customer's usage of a product. Meter events are used to bill a customer based on their usage. - * Meter events are associated with billing meters, which define the shape of the event's payload and how those events are aggregated for billing. + * @description Meter events represent actions that customers take in your system. You can use meter events to bill a customer based on their usage. Meter events are associated with billing meters, which define both the contents of the event’s payload and how to aggregate those events. */ "billing.meter_event": { /** @@ -10346,11 +10384,20 @@ export interface components { /** BillingCreditGrantsResourceBalanceCredit */ billing_credit_grants_resource_balance_credit: { amount: components["schemas"]["billing_credit_grants_resource_amount"]; + /** @description Details of the invoice to which the reinstated credits were originally applied. Only present if `type` is `credits_application_invoice_voided`. */ + credits_application_invoice_voided?: components["schemas"]["billing_credit_grants_resource_balance_credits_application_invoice_voided"] | null; /** * @description The type of credit transaction. * @enum {string} */ - type: "credits_granted"; + type: "credits_application_invoice_voided" | "credits_granted"; + }; + /** BillingCreditGrantsResourceBalanceCreditsApplicationInvoiceVoided */ + billing_credit_grants_resource_balance_credits_application_invoice_voided: { + /** @description The invoice to which the reinstated billing credits were originally applied. */ + invoice: string | components["schemas"]["invoice"]; + /** @description The invoice line item to which the reinstated billing credits were originally applied. */ + invoice_line_item: string; }; /** BillingCreditGrantsResourceBalanceCreditsApplied */ billing_credit_grants_resource_balance_credits_applied: { @@ -10380,7 +10427,7 @@ export interface components { /** BillingCreditGrantsResourceScope */ billing_credit_grants_resource_scope: { /** - * @description The price type for which credit grants can apply. We currently only support the `metered` price type. This refers to prices that have a [Billing Meter](https://docs.stripe.com/api/billing/meter) attached to them. + * @description The price type that credit grants can apply to. We currently only support the `metered` price type. This refers to prices that have a [Billing Meter](https://docs.stripe.com/api/billing/meter) attached to them. * @enum {string} */ price_type: "metered"; @@ -10595,13 +10642,21 @@ export interface components { address_zip?: string | null; /** @description If `address_zip` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`. */ address_zip_check?: string | null; + /** + * @description This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to “unspecified”. + * @enum {string|null} + */ + allow_redisplay?: "always" | "limited" | "unspecified" | null; /** @description A set of available payout methods for this card. Only values from this set should be passed as the `method` when creating a payout. */ available_payout_methods?: ("instant" | "standard")[] | null; /** @description Card brand. Can be `American Express`, `Diners Club`, `Discover`, `Eftpos Australia`, `Girocard`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`. */ brand: string; /** @description Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected. */ country?: string | null; - /** @description Three-letter [ISO code for currency](https://www.iso.org/iso-4217-currency-codes.html) in lowercase. Must be a [supported currency](https://docs.stripe.com/currencies). Only applicable on accounts (not customers or recipients). The card can be used as a transfer destination for funds in this currency. This property is only available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. */ + /** + * Format: currency + * @description Three-letter [ISO code for currency](https://www.iso.org/iso-4217-currency-codes.html) in lowercase. Must be a [supported currency](https://docs.stripe.com/currencies). Only applicable on accounts (not customers or recipients). The card can be used as a transfer destination for funds in this currency. This property is only available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. + */ currency?: string | null; /** @description The customer that this card belongs to. This attribute will not be in the card object if the card belongs to an account or recipient instead. */ customer?: (string | components["schemas"]["customer"] | components["schemas"]["deleted_customer"]) | null; @@ -10623,6 +10678,8 @@ export interface components { funding: string; /** @description Unique identifier for the object. */ id: string; + /** @description Issuer identification number of the card. */ + iin?: string; /** @description The last four digits of the card. */ last4: string; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ @@ -10637,6 +10694,11 @@ export interface components { * @enum {string} */ object: "card"; + /** + * @description Status of a card based on the card issuer. + * @enum {string|null} + */ + regulated_status?: "regulated" | "unregulated" | null; /** @description For external accounts that are cards, possible values are `new` and `errored`. If a payout fails, the status is set to `errored` and [scheduled payouts](https://stripe.com/docs/payouts#payout-schedule) are stopped until account details are updated. */ status?: string | null; /** @description If the card number is tokenized, this is the method that was used. Can be `android_pay` (includes Google Pay), `apple_pay`, `masterpass`, `visa_checkout`, or null. */ @@ -10711,7 +10773,10 @@ export interface components { * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ created: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description ID of the customer this charge is for if one exists. */ customer?: (string | components["schemas"]["customer"] | components["schemas"]["deleted_customer"]) | null; @@ -10813,6 +10878,10 @@ export interface components { }; /** ChargeOutcome */ charge_outcome: { + /** @description For charges declined by the network, a 2 digit code which indicates the advice returned by the network on how to proceed with an error. */ + network_advice_code?: string | null; + /** @description For charges declined by the network, a brand specific 2, 3, or 4 digit code which indicates the reason the authorization failed. */ + network_decline_code?: string | null; /** @description Possible values are `approved_by_network`, `declined_by_network`, `not_sent_to_network`, and `reversed_after_approval`. The value `reversed_after_approval` indicates the payment was [blocked by Stripe](https://stripe.com/docs/declines#blocked-payments) after bank authorization, and may temporarily appear as "pending" on a cardholder's statement. */ network_status?: string | null; /** @description An enumerated value providing a more detailed explanation of the outcome's `type`. Charges blocked by Radar's default block rule have the value `highest_risk_level`. Charges placed in review by Radar's default review rule have the value `elevated_risk_level`. Charges authorized, blocked, or placed in review by custom rules have the value `rule`. See [understanding declines](https://stripe.com/docs/declines) for more details. */ @@ -10886,7 +10955,10 @@ export interface components { * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ created: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency?: string | null; /** @description Currency conversion details for [Adaptive Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing) sessions */ currency_conversion?: components["schemas"]["payment_pages_checkout_session_currency_conversion"] | null; @@ -11516,9 +11588,15 @@ export interface components { capture_method?: "manual"; }; /** checkout_payment_method_options_mandate_options_bacs_debit */ - checkout_payment_method_options_mandate_options_bacs_debit: Record; + checkout_payment_method_options_mandate_options_bacs_debit: { + /** @description Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'. */ + reference_prefix?: string; + }; /** checkout_payment_method_options_mandate_options_sepa_debit */ - checkout_payment_method_options_mandate_options_sepa_debit: Record; + checkout_payment_method_options_mandate_options_sepa_debit: { + /** @description Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'. */ + reference_prefix?: string; + }; /** CheckoutPaynowPaymentMethodOptions */ checkout_paynow_payment_method_options: { /** @@ -12051,7 +12129,10 @@ export interface components { connect_collection_transfer: { /** @description Amount transferred, in cents (or local equivalent). */ amount: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description ID of the account that funds are being collected for. */ destination: string | components["schemas"]["account"]; @@ -12073,7 +12154,7 @@ export interface components { }; /** ConnectEmbeddedAccountFeaturesClaim */ connect_embedded_account_features_claim: { - /** @description Disables Stripe user authentication for this embedded component. This feature can only be false for accounts where you’re responsible for collecting updated information when requirements are due or change, like custom accounts. The default value for this feature is `false` when `external_account_collection` is enabled and `true` otherwise. */ + /** @description Disables Stripe user authentication for this embedded component. This value can only be true for accounts where `controller.requirement_collection` is `application`. The default value is the opposite of the `external_account_collection` value. For example, if you don’t set `external_account_collection`, it defaults to true and `disable_stripe_user_authentication` defaults to false. */ disable_stripe_user_authentication: boolean; /** @description Whether to allow platforms to control bank account collection for their connected accounts. This feature can only be false for accounts where you’re responsible for collecting updated information when requirements are due or change, like custom accounts. Otherwise, bank account collection is determined by compliance requirements. The default value for this feature is `true`. */ external_account_collection: boolean; @@ -12125,7 +12206,7 @@ export interface components { }; /** ConnectEmbeddedPayoutsFeatures */ connect_embedded_payouts_features: { - /** @description Disables Stripe user authentication for this embedded component. This feature can only be false for accounts where you’re responsible for collecting updated information when requirements are due or change, like custom accounts. The default value for this feature is `false` when `external_account_collection` is enabled and `true` otherwise. */ + /** @description Disables Stripe user authentication for this embedded component. This value can only be true for accounts where `controller.requirement_collection` is `application`. The default value is the opposite of the `external_account_collection` value. For example, if you don’t set `external_account_collection`, it defaults to true and `disable_stripe_user_authentication` defaults to false. */ disable_stripe_user_authentication: boolean; /** @description Whether to allow payout schedule to be changed. Default `true` when Stripe owns Loss Liability, default `false` otherwise. */ edit_payout_schedule: boolean; @@ -12194,7 +12275,10 @@ export interface components { * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ created: number; - /** @description If `amount_off` has been set, the three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the amount to take off. */ + /** + * Format: currency + * @description If `amount_off` has been set, the three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the amount to take off. + */ currency?: string | null; /** @description Coupons defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies). */ currency_options?: { @@ -12267,7 +12351,10 @@ export interface components { * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ created: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description ID of the customer. */ customer: string | components["schemas"]["customer"] | components["schemas"]["deleted_customer"]; @@ -12720,7 +12807,10 @@ export interface components { created: number; /** @description The ID of the credit note (if any) related to the transaction. */ credit_note?: (string | components["schemas"]["credit_note"]) | null; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description The ID of the customer the transaction belongs to. */ customer: string | components["schemas"]["customer"]; @@ -13392,7 +13482,10 @@ export interface components { * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ created: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description List of eligibility types that are included in `enhanced_evidence`. */ enhanced_eligibility_types: "visa_compelling_evidence_3"[]; @@ -13427,6 +13520,7 @@ export interface components { /** DisputeEnhancedEligibility */ dispute_enhanced_eligibility: { visa_compelling_evidence_3?: components["schemas"]["dispute_enhanced_eligibility_visa_compelling_evidence3"]; + visa_compliance?: components["schemas"]["dispute_enhanced_eligibility_visa_compliance"]; }; /** DisputeEnhancedEligibilityVisaCompellingEvidence3 */ dispute_enhanced_eligibility_visa_compelling_evidence3: { @@ -13438,9 +13532,18 @@ export interface components { */ status: "not_qualified" | "qualified" | "requires_action"; }; + /** DisputeEnhancedEligibilityVisaCompliance */ + dispute_enhanced_eligibility_visa_compliance: { + /** + * @description Visa compliance eligibility status. + * @enum {string} + */ + status: "fee_acknowledged" | "requires_fee_acknowledgement"; + }; /** DisputeEnhancedEvidence */ dispute_enhanced_evidence: { visa_compelling_evidence_3?: components["schemas"]["dispute_enhanced_evidence_visa_compelling_evidence3"]; + visa_compliance?: components["schemas"]["dispute_enhanced_evidence_visa_compliance"]; }; /** DisputeEnhancedEvidenceVisaCompellingEvidence3 */ dispute_enhanced_evidence_visa_compelling_evidence3: { @@ -13449,6 +13552,11 @@ export interface components { /** @description List of exactly two prior undisputed transaction objects for Visa Compelling Evidence 3.0 evidence submission. */ prior_undisputed_transactions: components["schemas"]["dispute_visa_compelling_evidence3_prior_undisputed_transaction"][]; }; + /** DisputeEnhancedEvidenceVisaCompliance */ + dispute_enhanced_evidence_visa_compliance: { + /** @description A field acknowledging the fee incurred when countering a Visa compliance dispute. If this field is set to true, evidence can be submitted for the compliance dispute. Stripe collects a 500 USD (or local equivalent) amount to cover the network costs associated with resolving compliance disputes. Stripe refunds the 500 USD network fee if you win the dispute. */ + fee_acknowledged: boolean; + }; /** DisputeEvidence */ dispute_evidence: { /** @description Any server or activity logs showing proof that the customer accessed or downloaded the purchased digital product. This information should include IP addresses, corresponding timestamps, and any detailed recorded activity. */ @@ -13826,7 +13934,10 @@ export interface components { amount: number; /** @description ID of the Connect application that earned the fee. */ application?: string | null; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ description?: string | null; @@ -13851,7 +13962,10 @@ export interface components { * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ created: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description ID of the application fee that was refunded. */ fee: string | components["schemas"]["application_fee"]; @@ -14190,7 +14304,10 @@ export interface components { columns?: string[]; /** @description Connected account ID by which to filter the report run. */ connected_account?: string; - /** @description Currency of objects to be included in the report run. */ + /** + * Format: currency + * @description Currency of objects to be included in the report run. + */ currency?: string; /** * Format: unix-time @@ -14297,7 +14414,7 @@ export interface components { /** @description The PaymentMethod to insert into the forwarded request. Forwarding previously consumed PaymentMethods is allowed. */ payment_method: string; /** @description The field kinds to be replaced in the forwarded request. */ - replacements: ("card_cvc" | "card_expiry" | "card_number" | "cardholder_name")[]; + replacements: ("card_cvc" | "card_expiry" | "card_number" | "cardholder_name" | "request_signature")[]; /** @description Context about the request from Stripe's servers to the destination endpoint. */ request_context?: components["schemas"]["forwarded_request_context"] | null; /** @description The request that was sent to the destination endpoint. We redact any sensitive fields. */ @@ -14386,8 +14503,10 @@ export interface components { * @description Iban Records contain E.U. bank account details per the SEPA format. */ funding_instructions_bank_transfer_iban_record: { + account_holder_address: components["schemas"]["address"]; /** @description The name of the person or business that owns the bank account */ account_holder_name: string; + bank_address: components["schemas"]["address"]; /** @description The BIC/SWIFT code of the account. */ bic: string; /** @description Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). */ @@ -14400,10 +14519,12 @@ export interface components { * @description Sort Code Records contain U.K. bank account details per the sort code format. */ funding_instructions_bank_transfer_sort_code_record: { + account_holder_address: components["schemas"]["address"]; /** @description The name of the person or business that owns the bank account */ account_holder_name: string; /** @description The account number */ account_number: string; + bank_address: components["schemas"]["address"]; /** @description The six-digit sort code */ sort_code: string; }; @@ -14412,6 +14533,10 @@ export interface components { * @description SPEI Records contain Mexico bank account details per the SPEI format. */ funding_instructions_bank_transfer_spei_record: { + account_holder_address: components["schemas"]["address"]; + /** @description The account holder name */ + account_holder_name: string; + bank_address: components["schemas"]["address"]; /** @description The three-digit bank code */ bank_code: string; /** @description The short banking institution name */ @@ -14442,12 +14567,14 @@ export interface components { * @description Zengin Records contain Japan bank account details per the Zengin format. */ funding_instructions_bank_transfer_zengin_record: { + account_holder_address: components["schemas"]["address"]; /** @description The account holder name */ account_holder_name?: string | null; /** @description The account number */ account_number?: string | null; /** @description The bank account type. In Japan, this can only be `futsu` or `toza`. */ account_type?: string | null; + bank_address: components["schemas"]["address"]; /** @description The bank code of the account */ bank_code?: string | null; /** @description The bank name of the account */ @@ -15021,7 +15148,10 @@ export interface components { * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ created: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description Custom fields displayed on the invoice. */ custom_fields?: components["schemas"]["invoice_setting_custom_field"][] | null; @@ -15456,7 +15586,10 @@ export interface components { invoiceitem: { /** @description Amount (in the `currency` specified) of the invoice item. This should always be equal to `unit_amount * quantity`. */ amount: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description The ID of the customer who will be billed when this invoice item is billed. */ customer: string | components["schemas"]["customer"] | components["schemas"]["deleted_customer"]; @@ -15556,10 +15689,10 @@ export interface components { /** InvoicesResourceInvoiceTaxID */ invoices_resource_invoice_tax_id: { /** - * @description The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, or `unknown` + * @description The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, or `unknown` * @enum {string} */ - type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "by_tin" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "li_vat" | "ma_vat" | "md_vat" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "tz_vat" | "ua_vat" | "unknown" | "us_ein" | "uy_ruc" | "uz_tin" | "uz_vat" | "ve_rif" | "vn_tin" | "za_vat"; + type: "ad_nrt" | "ae_trn" | "al_tin" | "am_tin" | "ao_tin" | "ar_cuit" | "au_abn" | "au_arn" | "ba_tin" | "bb_tin" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "bs_tin" | "by_tin" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "cd_nif" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "gn_nif" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kh_tin" | "kr_brn" | "kz_bin" | "li_uid" | "li_vat" | "ma_vat" | "md_vat" | "me_pib" | "mk_vat" | "mr_nif" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "np_pan" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sn_ninea" | "sr_fin" | "sv_nit" | "th_vat" | "tj_tin" | "tr_tin" | "tw_vat" | "tz_vat" | "ua_vat" | "ug_tin" | "unknown" | "us_ein" | "uy_ruc" | "uz_tin" | "uz_vat" | "ve_rif" | "vn_tin" | "za_vat" | "zm_tin" | "zw_tin"; /** @description The value of the tax ID. */ value?: string | null; }; @@ -15655,7 +15788,10 @@ export interface components { * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ created: number; - /** @description The currency of the cardholder. This currency can be different from the currency presented at authorization and the `merchant_currency` field on this authorization. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description The currency of the cardholder. This currency can be different from the currency presented at authorization and the `merchant_currency` field on this authorization. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description Fleet-specific information for authorizations using Fleet cards. */ fleet?: components["schemas"]["issuing_authorization_fleet_data"] | null; @@ -15669,7 +15805,10 @@ export interface components { livemode: boolean; /** @description The total amount that was authorized or rejected. This amount is in the `merchant_currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). `merchant_amount` should be the same as `amount`, unless `merchant_currency` and `currency` are different. */ merchant_amount: number; - /** @description The local currency that was presented to the cardholder for the authorization. This currency can be different from the cardholder currency and the `currency` field on this authorization. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description The local currency that was presented to the cardholder for the authorization. This currency can be different from the cardholder currency and the `currency` field on this authorization. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ merchant_currency: string; merchant_data: components["schemas"]["issuing_authorization_merchant_data"]; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ @@ -15722,7 +15861,10 @@ export interface components { * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ created: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Supported currencies are `usd` in the US, `eur` in the EU, and `gbp` in the UK. */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Supported currencies are `usd` in the US, `eur` in the EU, and `gbp` in the UK. + */ currency: string; /** @description The card's CVC. For security reasons, this is only available for virtual cards, and will be omitted unless you explicitly request it with [the `expand` parameter](https://stripe.com/docs/api/expanding_objects). Additionally, it's only available via the ["Retrieve a card" endpoint](https://stripe.com/docs/api/issuing/cards/retrieve), not via "List all cards" or any other endpoint. */ cvc?: string; @@ -15845,7 +15987,10 @@ export interface components { * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ created: number; - /** @description The currency the `transaction` was made in. */ + /** + * Format: currency + * @description The currency the `transaction` was made in. + */ currency: string; evidence: components["schemas"]["issuing_dispute_evidence"]; /** @description Unique identifier for the object. */ @@ -15962,7 +16107,10 @@ export interface components { * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ created: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description Unique identifier for the object. */ id: string; @@ -16075,7 +16223,10 @@ export interface components { * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ created: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description If you've disputed the transaction, the ID of the dispute. */ dispute?: (string | components["schemas"]["issuing.dispute"]) | null; @@ -16085,7 +16236,10 @@ export interface components { livemode: boolean; /** @description The amount that the merchant will receive, denominated in `merchant_currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). It will be different from `amount` if the merchant is taking payment in a different currency. */ merchant_amount: number; - /** @description The currency with which the merchant is taking payment. */ + /** + * Format: currency + * @description The currency with which the merchant is taking payment. + */ merchant_currency: string; merchant_data: components["schemas"]["issuing_authorization_merchant_data"]; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ @@ -16267,6 +16421,8 @@ export interface components { postal_code?: string | null; /** @description State where the seller is located */ state?: string | null; + /** @description The seller's tax identification number. Currently populated for French merchants only. */ + tax_id?: string | null; /** @description An ID assigned by the seller to the location of the sale. */ terminal_id?: string | null; /** @description URL provided by the merchant on a 3DS request */ @@ -16287,13 +16443,19 @@ export interface components { amount: number; /** @description Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ amount_details?: components["schemas"]["issuing_authorization_amount_details"] | null; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description If set `true`, you may provide [amount](https://stripe.com/docs/api/issuing/authorizations/approve#approve_issuing_authorization-amount) to control how much to hold for the authorization. */ is_amount_controllable: boolean; /** @description The amount the merchant is requesting to be authorized in the `merchant_currency`. The amount is in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ merchant_amount: number; - /** @description The local currency the merchant is requesting to authorize. */ + /** + * Format: currency + * @description The local currency the merchant is requesting to authorize. + */ merchant_currency: string; /** @description The card network's estimate of the likelihood that an authorization is fraudulent. Takes on values between 1 and 99. */ network_risk_score?: number | null; @@ -16402,7 +16564,10 @@ export interface components { blocked_merchant_countries?: string[] | null; /** @description Limit spending with amount-based rules that apply across any cards this card replaced (i.e., its `replacement_for` card and _that_ card's `replacement_for` card, up the chain). */ spending_limits?: components["schemas"]["issuing_card_spending_limit"][] | null; - /** @description Currency of the amounts within `spending_limits`. Always the same as the currency of the card. */ + /** + * Format: currency + * @description Currency of the amounts within `spending_limits`. Always the same as the currency of the card. + */ spending_limits_currency?: string | null; }; /** IssuingCardGooglePay */ @@ -16513,7 +16678,10 @@ export interface components { blocked_merchant_countries?: string[] | null; /** @description Limit spending with amount-based rules that apply across this cardholder's cards. */ spending_limits?: components["schemas"]["issuing_cardholder_spending_limit"][] | null; - /** @description Currency of the amounts within `spending_limits`. */ + /** + * Format: currency + * @description Currency of the amounts within `spending_limits`. + */ spending_limits_currency?: string | null; }; /** IssuingCardholderCardIssuing */ @@ -17068,10 +17236,13 @@ export interface components { amount_tax: number; /** @description Total after discounts and taxes. */ amount_total: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description An arbitrary string attached to the object. Often useful for displaying to users. Defaults to product name. */ - description?: string; + description?: string | null; /** @description The discounts applied to the line item. */ discounts?: components["schemas"]["line_items_discount_amount"][]; /** @description Unique identifier for the object. */ @@ -17226,7 +17397,10 @@ export interface components { amount: number; /** @description The integer amount in cents (or local equivalent) representing the amount for this line item, excluding all tax and discounts. */ amount_excluding_tax?: number | null; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ description?: string | null; @@ -17452,7 +17626,10 @@ export interface components { mandate_single_use: { /** @description The amount of the payment on a single use mandate. */ amount: number; - /** @description The currency of the payment on a single use mandate. */ + /** + * Format: currency + * @description The currency of the payment on a single use mandate. + */ currency: string; }; /** mandate_us_bank_account */ @@ -17802,7 +17979,10 @@ export interface components { * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ created: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description ID of the Customer this PaymentIntent belongs to, if one exists. * @@ -17965,7 +18145,10 @@ export interface components { payment_intent_next_action_display_bank_transfer_instructions: { /** @description The remaining amount that needs to be transferred to complete the payment. */ amount_remaining?: number | null; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency?: string | null; /** @description A list of financial addresses that can be used to fund the customer balance */ financial_addresses?: components["schemas"]["funding_instructions_bank_transfer_financial_address"][]; @@ -18385,9 +18568,15 @@ export interface components { transaction_type?: "business" | "personal" | null; }; /** payment_intent_payment_method_options_mandate_options_bacs_debit */ - payment_intent_payment_method_options_mandate_options_bacs_debit: Record; + payment_intent_payment_method_options_mandate_options_bacs_debit: { + /** @description Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'. */ + reference_prefix?: string; + }; /** payment_intent_payment_method_options_mandate_options_sepa_debit */ - payment_intent_payment_method_options_mandate_options_sepa_debit: Record; + payment_intent_payment_method_options_mandate_options_sepa_debit: { + /** @description Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'. */ + reference_prefix?: string; + }; /** payment_intent_payment_method_options_mobilepay */ payment_intent_payment_method_options_mobilepay: { /** @@ -18424,7 +18613,7 @@ export interface components { }; /** payment_intent_payment_method_options_swish */ payment_intent_payment_method_options_swish: { - /** @description The order ID displayed in the Swish app after the payment is authorized. */ + /** @description A reference for this payment to be displayed in the Swish app. */ reference?: string | null; /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -18541,7 +18730,10 @@ export interface components { billing_address_collection: "auto" | "required"; /** @description When set, provides configuration to gather active consent from customers. */ consent_collection?: components["schemas"]["payment_links_resource_consent_collection"] | null; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description Collect additional information from your customer using custom fields. Up to 3 fields are supported. */ custom_fields: components["schemas"]["payment_links_resource_custom_fields"][]; @@ -19008,6 +19200,11 @@ export interface components { last4: string; /** @description Contains information about card networks that can be used to process the payment. */ networks?: components["schemas"]["networks"] | null; + /** + * @description Status of a card based on the card issuer. + * @enum {string|null} + */ + regulated_status?: "regulated" | "unregulated" | null; /** @description Contains details on how this Card may be used for 3D Secure authentication. */ three_d_secure_usage?: components["schemas"]["three_d_secure_usage"] | null; /** @description If this Card is part of a card wallet, this contains the details of the card wallet. */ @@ -19357,7 +19554,9 @@ export interface components { /** payment_method_details_alma */ payment_method_details_alma: Record; /** payment_method_details_amazon_pay */ - payment_method_details_amazon_pay: Record; + payment_method_details_amazon_pay: { + funding?: components["schemas"]["amazon_pay_underlying_payment_method_funding_details"]; + }; /** payment_method_details_au_becs_debit */ payment_method_details_au_becs_debit: { /** @description Bank-State-Branch number of the bank account. */ @@ -19456,7 +19655,14 @@ export interface components { network?: string | null; /** @description If this card has network token credentials, this contains the details of the network token credentials. */ network_token?: components["schemas"]["payment_method_details_card_network_token"] | null; + /** @description This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. The first three digits of the Trace ID is the Financial Network Code, the next 6 digits is the Banknet Reference Number, and the last 4 digits represent the date (MM/DD). This field will be available for successful Visa, Mastercard, or American Express transactions and always null for other card brands. */ + network_transaction_id?: string | null; overcapture?: components["schemas"]["payment_flows_private_payment_methods_card_details_api_resource_enterprise_features_overcapture_overcapture"]; + /** + * @description Status of a card based on the card issuer. + * @enum {string|null} + */ + regulated_status?: "regulated" | "unregulated" | null; /** @description Populated if this transaction used 3D Secure authentication. */ three_d_secure?: components["schemas"]["three_d_secure_details_charge"] | null; /** @description If this Card is part of a card wallet, this contains the details of the card wallet. */ @@ -19861,6 +20067,21 @@ export interface components { * Przelewy24 rarely provides this information so the attribute is usually empty. */ verified_name?: string | null; }; + /** payment_method_details_passthrough_card */ + payment_method_details_passthrough_card: { + /** @description Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ + brand?: string | null; + /** @description Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected. */ + country?: string | null; + /** @description Two-digit number representing the card's expiration month. */ + exp_month?: number | null; + /** @description Four-digit number representing the card's expiration year. */ + exp_year?: number | null; + /** @description Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. */ + funding?: string | null; + /** @description The last four digits of the card. */ + last4?: string | null; + }; /** payment_method_details_payco */ payment_method_details_payco: { /** @description A unique identifier for the buyer as determined by the local payment processor. */ @@ -19897,7 +20118,9 @@ export interface components { reference?: string | null; }; /** payment_method_details_revolut_pay */ - payment_method_details_revolut_pay: Record; + payment_method_details_revolut_pay: { + funding?: components["schemas"]["revolut_pay_underlying_payment_method_funding_details"]; + }; /** payment_method_details_samsung_pay */ payment_method_details_samsung_pay: { /** @description A unique identifier for the buyer as determined by the local payment processor. */ @@ -21084,10 +21307,10 @@ export interface components { /** PaymentPagesCheckoutSessionTaxID */ payment_pages_checkout_session_tax_id: { /** - * @description The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, or `unknown` + * @description The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, or `unknown` * @enum {string} */ - type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "by_tin" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "li_vat" | "ma_vat" | "md_vat" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "tz_vat" | "ua_vat" | "unknown" | "us_ein" | "uy_ruc" | "uz_tin" | "uz_vat" | "ve_rif" | "vn_tin" | "za_vat"; + type: "ad_nrt" | "ae_trn" | "al_tin" | "am_tin" | "ao_tin" | "ar_cuit" | "au_abn" | "au_arn" | "ba_tin" | "bb_tin" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "bs_tin" | "by_tin" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "cd_nif" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "gn_nif" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kh_tin" | "kr_brn" | "kz_bin" | "li_uid" | "li_vat" | "ma_vat" | "md_vat" | "me_pib" | "mk_vat" | "mr_nif" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "np_pan" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sn_ninea" | "sr_fin" | "sv_nit" | "th_vat" | "tj_tin" | "tr_tin" | "tw_vat" | "tz_vat" | "ua_vat" | "ug_tin" | "unknown" | "us_ein" | "uy_ruc" | "uz_tin" | "uz_vat" | "ve_rif" | "vn_tin" | "za_vat" | "zm_tin" | "zw_tin"; /** @description The value of the tax ID. */ value?: string | null; }; @@ -21152,7 +21375,10 @@ export interface components { * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ created: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ description?: string | null; @@ -21330,7 +21556,7 @@ export interface components { currently_due: string[]; /** @description Fields that are `currently_due` and need to be collected again because validation or verification failed. */ errors: components["schemas"]["account_requirements_error"][]; - /** @description Fields that need to be collected assuming all volume thresholds are reached. As they become required, they appear in `currently_due` as well, and the account's `future_requirements[current_deadline]` becomes set. */ + /** @description Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well, and the account's `future_requirements[current_deadline]` becomes set. */ eventually_due: string[]; /** @description Fields that weren't collected by the account's `requirements.current_deadline`. These fields need to be collected to enable the person's account. New fields will never appear here; `future_requirements.past_due` will always be a subset of `requirements.past_due`. */ past_due: string[]; @@ -21339,6 +21565,8 @@ export interface components { }; /** PersonRelationship */ person_relationship: { + /** @description Whether the person is the authorizer of the account's representative. */ + authorizer?: boolean | null; /** @description Whether the person is a director of the account's legal entity. Directors are typically members of the governing board of the company, or responsible for ensuring the company meets its regulatory obligations. */ director?: boolean | null; /** @description Whether the person has significant responsibility to control, manage, or direct the organization. */ @@ -21362,7 +21590,7 @@ export interface components { currently_due: string[]; /** @description Fields that are `currently_due` and need to be collected again because validation or verification failed. */ errors: components["schemas"]["account_requirements_error"][]; - /** @description Fields that need to be collected assuming all volume thresholds are reached. As they become required, they appear in `currently_due` as well, and the account's `current_deadline` becomes set. */ + /** @description Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well, and the account's `current_deadline` becomes set. */ eventually_due: string[]; /** @description Fields that weren't collected by the account's `current_deadline`. These fields need to be collected to enable the person's account. */ past_due: string[]; @@ -21405,7 +21633,10 @@ export interface components { * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ created: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description Unique identifier for the object. */ id: string; @@ -21662,7 +21893,7 @@ export interface components { * @enum {string} */ proration_behavior: "always_invoice" | "create_prorations" | "none"; - schedule_at_period_end?: components["schemas"]["portal_resource_schedule_update_at_period_end"]; + schedule_at_period_end: components["schemas"]["portal_resource_schedule_update_at_period_end"]; }; /** PortalSubscriptionUpdateProduct */ portal_subscription_update_product: { @@ -21693,7 +21924,10 @@ export interface components { * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ created: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description Prices defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies). */ currency_options?: { @@ -22335,7 +22569,10 @@ export interface components { * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ created: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description An arbitrary string attached to the object. You can use this for displaying to users (available on non-card refunds only). */ description?: string; @@ -22612,7 +22849,10 @@ export interface components { /** ReserveTransaction */ reserve_transaction: { amount: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ description?: string | null; @@ -22673,6 +22913,15 @@ export interface components { /** @description Information related to the browsing session of the user who initiated the payment. */ session?: components["schemas"]["radar_review_resource_session"] | null; }; + /** revolut_pay_underlying_payment_method_funding_details */ + revolut_pay_underlying_payment_method_funding_details: { + card?: components["schemas"]["payment_method_details_passthrough_card"]; + /** + * @description funding type of the underlying payment method. + * @enum {string|null} + */ + type?: "card" | null; + }; /** RadarRule */ rule: { /** @description The action taken on the payment. */ @@ -22726,6 +22975,11 @@ export interface components { }; /** SchedulesPhaseAutomaticTax */ schedules_phase_automatic_tax: { + /** + * @description If Stripe disabled automatic tax, this enum describes why. + * @enum {string|null} + */ + disabled_reason?: "requires_location_inputs" | null; /** @description Whether Stripe automatically computes tax on invoices created during this phase. */ enabled: boolean; /** @description The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account. */ @@ -23159,7 +23413,10 @@ export interface components { * @enum {string} */ amount_type: "fixed" | "maximum"; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description A description of the mandate or subscription that is meant to be displayed to the customer. */ description?: string | null; @@ -23209,9 +23466,15 @@ export interface components { transaction_type?: "business" | "personal" | null; }; /** setup_intent_payment_method_options_mandate_options_bacs_debit */ - setup_intent_payment_method_options_mandate_options_bacs_debit: Record; + setup_intent_payment_method_options_mandate_options_bacs_debit: { + /** @description Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'. */ + reference_prefix?: string; + }; /** setup_intent_payment_method_options_mandate_options_sepa_debit */ - setup_intent_payment_method_options_mandate_options_sepa_debit: Record; + setup_intent_payment_method_options_mandate_options_sepa_debit: { + /** @description Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'. */ + reference_prefix?: string; + }; /** setup_intent_payment_method_options_paypal */ setup_intent_payment_method_options_paypal: { /** @description The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer. */ @@ -23326,7 +23589,10 @@ export interface components { shipping_rate_fixed_amount: { /** @description A non-negative integer in cents representing how much to charge. */ amount: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description Shipping rates defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies). */ currency_options?: { @@ -23356,6 +23622,11 @@ export interface components { ach_debit?: components["schemas"]["source_type_ach_debit"]; acss_debit?: components["schemas"]["source_type_acss_debit"]; alipay?: components["schemas"]["source_type_alipay"]; + /** + * @description This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to “unspecified”. + * @enum {string|null} + */ + allow_redisplay?: "always" | "limited" | "unspecified" | null; /** @description A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for `single_use` sources. */ amount?: number | null; au_becs_debit?: components["schemas"]["source_type_au_becs_debit"]; @@ -23370,7 +23641,10 @@ export interface components { * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ created: number; - /** @description Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) associated with the source. This is the currency for which the source will be chargeable once ready. Required for `single_use` sources. */ + /** + * Format: currency + * @description Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) associated with the source. This is the currency for which the source will be chargeable once ready. Required for `single_use` sources. + */ currency?: string | null; /** @description The ID of the customer to which this source is attached. This will not be present when the source has not been attached to a customer. */ customer?: string; @@ -23480,7 +23754,10 @@ export interface components { source_order: { /** @description A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount for the order. */ amount: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description The email address of the customer placing the order. */ email?: string; @@ -23565,7 +23842,10 @@ export interface components { * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ created: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; gbp_credit_transfer?: components["schemas"]["source_transaction_gbp_credit_transfer_data"]; /** @description Unique identifier for the object. */ @@ -23881,7 +24161,10 @@ export interface components { * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ created: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** * Format: unix-time @@ -24005,6 +24288,11 @@ export interface components { }; /** SubscriptionAutomaticTax */ subscription_automatic_tax: { + /** + * @description If Stripe disabled automatic tax, this enum describes why. + * @enum {string|null} + */ + disabled_reason?: "requires_location_inputs" | null; /** @description Whether Stripe automatically computes tax on this subscription. */ enabled: boolean; /** @description The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account. */ @@ -24222,7 +24510,10 @@ export interface components { collection_method?: "charge_automatically" | "send_invoice" | null; /** @description ID of the coupon to use during this phase of the subscription schedule. */ coupon?: (string | components["schemas"]["coupon"] | components["schemas"]["deleted_coupon"]) | null; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings. */ default_payment_method?: (string | components["schemas"]["payment_method"]) | null; @@ -24294,6 +24585,11 @@ export interface components { }; /** SubscriptionSchedulesResourceDefaultSettingsAutomaticTax */ subscription_schedules_resource_default_settings_automatic_tax: { + /** + * @description If Stripe disabled automatic tax, this enum describes why. + * @enum {string|null} + */ + disabled_reason?: "requires_location_inputs" | null; /** @description Whether Stripe automatically computes tax on invoices created during this phase. */ enabled: boolean; /** @description The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account. */ @@ -24766,10 +25062,10 @@ export interface components { /** @description The account or customer the tax ID belongs to. */ owner?: components["schemas"]["tax_i_ds_owner"] | null; /** - * @description Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, or `za_vat`. Note that some legacy tax IDs have type `unknown` + * @description Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `ba_tin`, `bb_tin`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kh_tin`, `kr_brn`, `kz_bin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin`. Note that some legacy tax IDs have type `unknown` * @enum {string} */ - type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "by_tin" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "li_vat" | "ma_vat" | "md_vat" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "tz_vat" | "ua_vat" | "unknown" | "us_ein" | "uy_ruc" | "uz_tin" | "uz_vat" | "ve_rif" | "vn_tin" | "za_vat"; + type: "ad_nrt" | "ae_trn" | "al_tin" | "am_tin" | "ao_tin" | "ar_cuit" | "au_abn" | "au_arn" | "ba_tin" | "bb_tin" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "bs_tin" | "by_tin" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "cd_nif" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "gn_nif" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kh_tin" | "kr_brn" | "kz_bin" | "li_uid" | "li_vat" | "ma_vat" | "md_vat" | "me_pib" | "mk_vat" | "mr_nif" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "np_pan" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sn_ninea" | "sr_fin" | "sv_nit" | "th_vat" | "tj_tin" | "tr_tin" | "tw_vat" | "tz_vat" | "ua_vat" | "ug_tin" | "unknown" | "us_ein" | "uy_ruc" | "uz_tin" | "uz_vat" | "ve_rif" | "vn_tin" | "za_vat" | "zm_tin" | "zw_tin"; /** @description Value of the tax ID. */ value: string; /** @description Tax ID verification information. */ @@ -24790,13 +25086,20 @@ export interface components { /** TaxProductRegistrationsResourceCountryOptions */ tax_product_registrations_resource_country_options: { ae?: components["schemas"]["tax_product_registrations_resource_country_options_default"]; + al?: components["schemas"]["tax_product_registrations_resource_country_options_default"]; + am?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; + ao?: components["schemas"]["tax_product_registrations_resource_country_options_default"]; at?: components["schemas"]["tax_product_registrations_resource_country_options_europe"]; au?: components["schemas"]["tax_product_registrations_resource_country_options_default"]; + ba?: components["schemas"]["tax_product_registrations_resource_country_options_default"]; + bb?: components["schemas"]["tax_product_registrations_resource_country_options_default"]; be?: components["schemas"]["tax_product_registrations_resource_country_options_europe"]; bg?: components["schemas"]["tax_product_registrations_resource_country_options_europe"]; bh?: components["schemas"]["tax_product_registrations_resource_country_options_default"]; + bs?: components["schemas"]["tax_product_registrations_resource_country_options_default"]; by?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; ca?: components["schemas"]["tax_product_registrations_resource_country_options_canada"]; + cd?: components["schemas"]["tax_product_registrations_resource_country_options_default"]; ch?: components["schemas"]["tax_product_registrations_resource_country_options_default"]; cl?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; co?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; @@ -24813,6 +25116,7 @@ export interface components { fr?: components["schemas"]["tax_product_registrations_resource_country_options_europe"]; gb?: components["schemas"]["tax_product_registrations_resource_country_options_default"]; ge?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; + gn?: components["schemas"]["tax_product_registrations_resource_country_options_default"]; gr?: components["schemas"]["tax_product_registrations_resource_country_options_europe"]; hr?: components["schemas"]["tax_product_registrations_resource_country_options_europe"]; hu?: components["schemas"]["tax_product_registrations_resource_country_options_europe"]; @@ -24822,6 +25126,7 @@ export interface components { it?: components["schemas"]["tax_product_registrations_resource_country_options_europe"]; jp?: components["schemas"]["tax_product_registrations_resource_country_options_default"]; ke?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; + kh?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; kr?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; kz?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; lt?: components["schemas"]["tax_product_registrations_resource_country_options_europe"]; @@ -24829,14 +25134,19 @@ export interface components { lv?: components["schemas"]["tax_product_registrations_resource_country_options_europe"]; ma?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; md?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; + me?: components["schemas"]["tax_product_registrations_resource_country_options_default"]; + mk?: components["schemas"]["tax_product_registrations_resource_country_options_default"]; + mr?: components["schemas"]["tax_product_registrations_resource_country_options_default"]; mt?: components["schemas"]["tax_product_registrations_resource_country_options_europe"]; mx?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; my?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; ng?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; nl?: components["schemas"]["tax_product_registrations_resource_country_options_europe"]; no?: components["schemas"]["tax_product_registrations_resource_country_options_default"]; + np?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; nz?: components["schemas"]["tax_product_registrations_resource_country_options_default"]; om?: components["schemas"]["tax_product_registrations_resource_country_options_default"]; + pe?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; pl?: components["schemas"]["tax_product_registrations_resource_country_options_europe"]; pt?: components["schemas"]["tax_product_registrations_resource_country_options_europe"]; ro?: components["schemas"]["tax_product_registrations_resource_country_options_europe"]; @@ -24847,13 +25157,20 @@ export interface components { sg?: components["schemas"]["tax_product_registrations_resource_country_options_default"]; si?: components["schemas"]["tax_product_registrations_resource_country_options_europe"]; sk?: components["schemas"]["tax_product_registrations_resource_country_options_europe"]; + sn?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; + sr?: components["schemas"]["tax_product_registrations_resource_country_options_default"]; th?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; + tj?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; tr?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; tz?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; + ug?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; us?: components["schemas"]["tax_product_registrations_resource_country_options_united_states"]; + uy?: components["schemas"]["tax_product_registrations_resource_country_options_default"]; uz?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; vn?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; za?: components["schemas"]["tax_product_registrations_resource_country_options_default"]; + zm?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; + zw?: components["schemas"]["tax_product_registrations_resource_country_options_default"]; }; /** TaxProductRegistrationsResourceCountryOptionsCaProvinceStandard */ tax_product_registrations_resource_country_options_ca_province_standard: { @@ -24962,10 +25279,10 @@ export interface components { /** TaxProductResourceCustomerDetailsResourceTaxId */ tax_product_resource_customer_details_resource_tax_id: { /** - * @description The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, or `unknown` + * @description The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, or `unknown` * @enum {string} */ - type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "by_tin" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "li_vat" | "ma_vat" | "md_vat" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "tz_vat" | "ua_vat" | "unknown" | "us_ein" | "uy_ruc" | "uz_tin" | "uz_vat" | "ve_rif" | "vn_tin" | "za_vat"; + type: "ad_nrt" | "ae_trn" | "al_tin" | "am_tin" | "ao_tin" | "ar_cuit" | "au_abn" | "au_arn" | "ba_tin" | "bb_tin" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "bs_tin" | "by_tin" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "cd_nif" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "gn_nif" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kh_tin" | "kr_brn" | "kz_bin" | "li_uid" | "li_vat" | "ma_vat" | "md_vat" | "me_pib" | "mk_vat" | "mr_nif" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "np_pan" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sn_ninea" | "sr_fin" | "sv_nit" | "th_vat" | "tj_tin" | "tr_tin" | "tw_vat" | "tz_vat" | "ua_vat" | "ug_tin" | "unknown" | "us_ein" | "uy_ruc" | "uz_tin" | "uz_vat" | "ve_rif" | "vn_tin" | "za_vat" | "zm_tin" | "zw_tin"; /** @description The value of the tax ID. */ value: string; }; @@ -25373,7 +25690,10 @@ export interface components { * @description Represents a cart to be displayed on the reader */ terminal_reader_reader_resource_cart: { - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description List of line items in the cart. */ line_items: components["schemas"]["terminal_reader_reader_resource_line_item"][]; @@ -25789,7 +26109,10 @@ export interface components { * @description Time that this record of the transfer was first created. */ created: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ description?: string | null; @@ -25871,7 +26194,10 @@ export interface components { * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ created: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description Linked payment refund for the transfer reversal. */ destination_payment_refund?: (string | components["schemas"]["refund"]) | null; @@ -25934,7 +26260,10 @@ export interface components { * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ created: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description The FinancialAccount to reverse funds from. */ financial_account: string; @@ -25981,7 +26310,10 @@ export interface components { * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ created: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description The FinancialAccount to reverse funds from. */ financial_account?: string | null; @@ -26100,7 +26432,10 @@ export interface components { * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ created: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ description?: string | null; @@ -26159,7 +26494,10 @@ export interface components { * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ created: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description ID of the [customer](https://stripe.com/docs/api/customers) to whom an OutboundPayment is sent. */ customer?: string | null; @@ -26226,7 +26564,10 @@ export interface components { * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ created: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ description?: string | null; @@ -26282,7 +26623,10 @@ export interface components { * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ created: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ description: string; @@ -26333,7 +26677,10 @@ export interface components { * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ created: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ description: string; @@ -26385,7 +26732,10 @@ export interface components { * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ created: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ description: string; @@ -26444,7 +26794,10 @@ export interface components { * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ created: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** * Format: unix-time @@ -26510,21 +26863,6 @@ export interface components { /** @description Additional details; includes at least one entry when the status is not `active`. */ status_details: components["schemas"]["treasury_financial_accounts_resource_toggles_setting_status_details"][]; }; - /** - * TreasuryFinancialAccountsResourceAchToggleSettings - * @description Toggle settings for enabling/disabling an ACH specific feature - */ - treasury_financial_accounts_resource_ach_toggle_settings: { - /** @description Whether the FinancialAccount should have the Feature. */ - requested: boolean; - /** - * @description Whether the Feature is operational. - * @enum {string} - */ - status: "active" | "pending" | "restricted"; - /** @description Additional details; includes at least one entry when the status is not `active`. */ - status_details: components["schemas"]["treasury_financial_accounts_resource_toggles_setting_status_details"][]; - }; /** * TreasuryFinancialAccountsResourceBalance * @description Balance information for the FinancialAccount @@ -26569,19 +26907,49 @@ export interface components { treasury_financial_accounts_resource_financial_addresses_features: { aba?: components["schemas"]["treasury_financial_accounts_resource_aba_toggle_settings"]; }; + /** + * TreasuryFinancialAccountsResourceInboundAchToggleSettings + * @description Toggle settings for enabling/disabling an inbound ACH specific feature + */ + treasury_financial_accounts_resource_inbound_ach_toggle_settings: { + /** @description Whether the FinancialAccount should have the Feature. */ + requested: boolean; + /** + * @description Whether the Feature is operational. + * @enum {string} + */ + status: "active" | "pending" | "restricted"; + /** @description Additional details; includes at least one entry when the status is not `active`. */ + status_details: components["schemas"]["treasury_financial_accounts_resource_toggles_setting_status_details"][]; + }; /** * TreasuryFinancialAccountsResourceInboundTransfers * @description InboundTransfers contains inbound transfers features for a FinancialAccount. */ treasury_financial_accounts_resource_inbound_transfers: { - ach?: components["schemas"]["treasury_financial_accounts_resource_ach_toggle_settings"]; + ach?: components["schemas"]["treasury_financial_accounts_resource_inbound_ach_toggle_settings"]; + }; + /** + * TreasuryFinancialAccountsResourceOutboundAchToggleSettings + * @description Toggle settings for enabling/disabling an outbound ACH specific feature + */ + treasury_financial_accounts_resource_outbound_ach_toggle_settings: { + /** @description Whether the FinancialAccount should have the Feature. */ + requested: boolean; + /** + * @description Whether the Feature is operational. + * @enum {string} + */ + status: "active" | "pending" | "restricted"; + /** @description Additional details; includes at least one entry when the status is not `active`. */ + status_details: components["schemas"]["treasury_financial_accounts_resource_toggles_setting_status_details"][]; }; /** * TreasuryFinancialAccountsResourceOutboundPayments * @description Settings related to Outbound Payments features on a Financial Account */ treasury_financial_accounts_resource_outbound_payments: { - ach?: components["schemas"]["treasury_financial_accounts_resource_ach_toggle_settings"]; + ach?: components["schemas"]["treasury_financial_accounts_resource_outbound_ach_toggle_settings"]; us_domestic_wire?: components["schemas"]["treasury_financial_accounts_resource_toggle_settings"]; }; /** @@ -26589,7 +26957,7 @@ export interface components { * @description OutboundTransfers contains outbound transfers features for a FinancialAccount. */ treasury_financial_accounts_resource_outbound_transfers: { - ach?: components["schemas"]["treasury_financial_accounts_resource_ach_toggle_settings"]; + ach?: components["schemas"]["treasury_financial_accounts_resource_outbound_ach_toggle_settings"]; us_domestic_wire?: components["schemas"]["treasury_financial_accounts_resource_toggle_settings"]; }; /** @@ -27402,6 +27770,7 @@ export interface operations { /** @enum {string} */ account_type?: "checking" | "futsu" | "savings" | "toza"; country: string; + /** Format: currency */ currency?: string; /** external_account_documents_param */ documents?: { @@ -27422,6 +27791,7 @@ export interface operations { /** annual_revenue_specs */ annual_revenue?: { amount: number; + /** Format: currency */ currency: string; fiscal_year_end: string; }; @@ -27430,6 +27800,7 @@ export interface operations { /** monthly_estimated_revenue_specs */ monthly_estimated_revenue?: { amount: number; + /** Format: currency */ currency: string; }; name?: string; @@ -27768,7 +28139,10 @@ export interface operations { }; /** @description The country in which the account holder resides, or in which the business is legally established. This should be an ISO 3166-1 alpha-2 country code. For example, if you are in the United States and the business for which you're creating an account is legally represented in Canada, you would use `CA` as the country for the account being created. Available countries include [Stripe's global markets](https://stripe.com/global) as well as countries where [cross-border payouts](https://stripe.com/docs/connect/cross-border-payouts) are supported. */ country?: string; - /** @description Three-letter ISO currency code representing the default currency for the account. This must be a currency that [Stripe supports in the account's country](https://docs.stripe.com/payouts). */ + /** + * Format: currency + * @description Three-letter ISO currency code representing the default currency for the account. This must be a currency that [Stripe supports in the account's country](https://docs.stripe.com/payouts). + */ default_currency?: string; /** * documents_specs @@ -27812,7 +28186,7 @@ export interface operations { external_account?: string; /** * account_groups_specs - * @description A hash of account group type to tokens. These are account groups this account should be added to + * @description A hash of account group type to tokens. These are account groups this account should be added to. */ groups?: { payments_pricing?: string | ""; @@ -28071,13 +28445,14 @@ export interface operations { /** @description An [account token](https://stripe.com/docs/api#create_account_token), used to securely provide details to the account. */ account_token?: string; /** - * business_profile_specs + * business_profile_update_specs * @description Business information about the account. */ business_profile?: { /** annual_revenue_specs */ annual_revenue?: { amount: number; + /** Format: currency */ currency: string; fiscal_year_end: string; }; @@ -28086,6 +28461,7 @@ export interface operations { /** monthly_estimated_revenue_specs */ monthly_estimated_revenue?: { amount: number; + /** Format: currency */ currency: string; }; name?: string; @@ -28335,7 +28711,7 @@ export interface operations { }; }; /** - * company_specs + * company_update_specs * @description Information about the company or business. This field is available for any `business_type`. Once you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. */ company?: { @@ -28399,7 +28775,10 @@ export interface operations { }; }; }; - /** @description Three-letter ISO currency code representing the default currency for the account. This must be a currency that [Stripe supports in the account's country](https://docs.stripe.com/payouts). */ + /** + * Format: currency + * @description Three-letter ISO currency code representing the default currency for the account. This must be a currency that [Stripe supports in the account's country](https://docs.stripe.com/payouts). + */ default_currency?: string; /** * documents_specs @@ -28443,13 +28822,13 @@ export interface operations { external_account?: string; /** * account_groups_specs - * @description A hash of account group type to tokens. These are account groups this account should be added to + * @description A hash of account group type to tokens. These are account groups this account should be added to. */ groups?: { payments_pricing?: string | ""; }; /** - * individual_specs + * individual_update_specs * @description Information about the person represented by the account. This field is null unless `business_type` is set to `individual`. Once you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. */ individual?: { @@ -28704,6 +29083,7 @@ export interface operations { /** @enum {string} */ account_type?: "checking" | "futsu" | "savings" | "toza"; country: string; + /** Format: currency */ currency?: string; /** external_account_documents_param */ documents?: { @@ -29120,6 +29500,7 @@ export interface operations { /** @enum {string} */ account_type?: "checking" | "futsu" | "savings" | "toza"; country: string; + /** Format: currency */ currency?: string; /** external_account_documents_param */ documents?: { @@ -29375,6 +29756,7 @@ export interface operations { limit?: number; /** @description Filters on the list of people returned based on the person's relationship to the account's company. */ relationship?: { + authorizer?: boolean; director?: boolean; executive?: boolean; legal_guardian?: boolean; @@ -29569,6 +29951,7 @@ export interface operations { * @description The relationship that this person has with the account's legal entity. */ relationship?: { + authorizer?: boolean; director?: boolean; executive?: boolean; legal_guardian?: boolean; @@ -29801,6 +30184,7 @@ export interface operations { * @description The relationship that this person has with the account's legal entity. */ relationship?: { + authorizer?: boolean; director?: boolean; executive?: boolean; legal_guardian?: boolean; @@ -29898,6 +30282,7 @@ export interface operations { limit?: number; /** @description Filters on the list of people returned based on the person's relationship to the account's company. */ relationship?: { + authorizer?: boolean; director?: boolean; executive?: boolean; legal_guardian?: boolean; @@ -30092,6 +30477,7 @@ export interface operations { * @description The relationship that this person has with the account's legal entity. */ relationship?: { + authorizer?: boolean; director?: boolean; executive?: boolean; legal_guardian?: boolean; @@ -30324,6 +30710,7 @@ export interface operations { * @description The relationship that this person has with the account's legal entity. */ relationship?: { + authorizer?: boolean; director?: boolean; executive?: boolean; legal_guardian?: boolean; @@ -31200,7 +31587,7 @@ export interface operations { source?: string; /** @description A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ starting_after?: string; - /** @description Only returns transactions of the given type. One of: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `climate_order_purchase`, `climate_order_refund`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_outbound`, `obligation_reversal_inbound`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`. */ + /** @description Only returns transactions of the given type. One of: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `climate_order_purchase`, `climate_order_refund`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_outbound`, `obligation_reversal_inbound`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `payout_minimum_balance_hold`, `payout_minimum_balance_release`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`. */ type?: string; }; header?: never; @@ -31306,7 +31693,7 @@ export interface operations { source?: string; /** @description A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ starting_after?: string; - /** @description Only returns transactions of the given type. One of: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `climate_order_purchase`, `climate_order_refund`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_outbound`, `obligation_reversal_inbound`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`. */ + /** @description Only returns transactions of the given type. One of: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `climate_order_purchase`, `climate_order_refund`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_outbound`, `obligation_reversal_inbound`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `payout_minimum_balance_hold`, `payout_minimum_balance_release`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`. */ type?: string; }; header?: never; @@ -31872,6 +32259,7 @@ export interface operations { amount: { /** monetary_amount_param */ monetary?: { + /** Format: currency */ currency: string; value: number; }; @@ -31898,17 +32286,17 @@ export interface operations { customer: string; /** * Format: unix-time - * @description The time when the billing credits become effective—when they're eligible for use. Defaults to the current timestamp if not specified. + * @description The time when the billing credits become effective-when they're eligible for use. It defaults to the current timestamp if not specified. */ effective_at?: number; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; /** * Format: unix-time - * @description The time when the billing credits will expire. If not specified, the billing credits don't expire. + * @description The time when the billing credits expire. If not specified, the billing credits don't expire. */ expires_at?: number; - /** @description Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object (for example, cost basis) in a structured format. */ + /** @description Set of key-value pairs that you can attach to an object. You can use this to store additional information about the object (for example, cost basis) in a structured format. */ metadata?: { [key: string]: string; }; @@ -31994,7 +32382,7 @@ export interface operations { expand?: string[]; /** @description The time when the billing credits created by this credit grant expire. If set to empty, the billing credits never expire. */ expires_at?: number | ""; - /** @description Set of key-value pairs you can attach to an object. This can be useful for storing additional information about the object (for example, cost basis) in a structured format. */ + /** @description Set of key-value pairs you can attach to an object. You can use this to store additional information about the object (for example, cost basis) in a structured format. */ metadata?: { [key: string]: string; }; @@ -32164,7 +32552,7 @@ export interface operations { event_name: string; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; - /** @description A unique identifier for the event. If not provided, one will be generated. We strongly advise using UUID-like identifiers. We will enforce uniqueness within a rolling period of at least 24 hours. The enforcement of uniqueness primarily addresses issues arising from accidental retries or other problems occurring within extremely brief time intervals. This approach helps prevent duplicate entries and ensures data integrity in high-frequency operations. */ + /** @description A unique identifier for the event. If not provided, one is generated. We recommend using UUID-like identifiers. We will enforce uniqueness within a rolling period of at least 24 hours. The enforcement of uniqueness primarily addresses issues arising from accidental retries or other problems occurring within extremely brief time intervals. This approach helps prevent duplicate entries and ensures data integrity in high-frequency operations. */ identifier?: string; /** @description The payload of the event. This must contain the fields corresponding to a meter's `customer_mapping.event_payload_key` (default is `stripe_customer_id`) and `value_settings.event_payload_key` (default is `value`). Read more about the [payload](https://docs.stripe.com/billing/subscriptions/usage-based/recording-usage#payload-key-overrides). */ payload: { @@ -32281,7 +32669,7 @@ export interface operations { /** @enum {string} */ formula: "count" | "sum"; }; - /** @description The meter's name. */ + /** @description The meter’s name. Not visible to the customer. */ display_name: string; /** @description The name of the meter event to record usage for. Corresponds with the `event_name` field on meter events. */ event_name: string; @@ -32375,7 +32763,7 @@ export interface operations { requestBody?: { content: { "application/x-www-form-urlencoded": { - /** @description The meter's name. */ + /** @description The meter’s name. Not visible to the customer. */ display_name?: string; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; @@ -33062,7 +33450,10 @@ export interface operations { /** @enum {string} */ object?: "card"; } | string; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency?: string; /** @description The ID of an existing customer that will be charged in this request. */ customer?: string; @@ -33490,6 +33881,10 @@ export interface operations { }; }[]; }; + /** visa_compliance */ + visa_compliance?: { + fee_acknowledged?: boolean; + }; } | ""; product_description?: string; receipt?: string; @@ -33704,7 +34099,10 @@ export interface operations { content: { "application/x-www-form-urlencoded": { amount?: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency?: string; /** @description Customer whose customer balance to refund from. */ customer?: string; @@ -33980,7 +34378,10 @@ export interface operations { /** @enum {string} */ terms_of_service?: "none" | "required"; }; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Required in `setup` mode when `payment_method_types` is not set. */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Required in `setup` mode when `payment_method_types` is not set. + */ currency?: string; /** @description Collect additional information from your customer using custom fields. Up to 3 fields are supported. */ custom_fields?: { @@ -34134,6 +34535,7 @@ export interface operations { price?: string; /** price_data_with_product_data */ price_data?: { + /** Format: currency */ currency: string; product?: string; /** product_data */ @@ -34288,7 +34690,9 @@ export interface operations { /** payment_method_options_param */ bacs_debit?: { /** payment_method_options_mandate_options_param */ - mandate_options?: Record; + mandate_options?: { + reference_prefix?: string | ""; + }; /** @enum {string} */ setup_future_usage?: "none" | "off_session" | "on_session"; }; @@ -34468,7 +34872,9 @@ export interface operations { /** payment_method_options_param */ sepa_debit?: { /** payment_method_options_mandate_options_param */ - mandate_options?: Record; + mandate_options?: { + reference_prefix?: string | ""; + }; /** @enum {string} */ setup_future_usage?: "none" | "off_session" | "on_session"; }; @@ -34584,6 +34990,7 @@ export interface operations { /** fixed_amount */ fixed_amount?: { amount: number; + /** Format: currency */ currency: string; currency_options?: { [key: string]: { @@ -35496,7 +35903,10 @@ export interface operations { applies_to?: { products?: string[]; }; - /** @description Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the `amount_off` parameter (required if `amount_off` is passed). */ + /** + * Format: currency + * @description Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the `amount_off` parameter (required if `amount_off` is passed). + */ currency?: string; /** @description Coupons defined in each available currency option (only supported if `amount_off` is passed). Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies). */ currency_options?: { @@ -36431,7 +36841,7 @@ export interface operations { /** @description The customer's tax IDs. */ tax_id_data?: { /** @enum {string} */ - type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "by_tin" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "li_vat" | "ma_vat" | "md_vat" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "tz_vat" | "ua_vat" | "us_ein" | "uy_ruc" | "uz_tin" | "uz_vat" | "ve_rif" | "vn_tin" | "za_vat"; + type: "ad_nrt" | "ae_trn" | "al_tin" | "am_tin" | "ao_tin" | "ar_cuit" | "au_abn" | "au_arn" | "ba_tin" | "bb_tin" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "bs_tin" | "by_tin" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "cd_nif" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "gn_nif" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kh_tin" | "kr_brn" | "kz_bin" | "li_uid" | "li_vat" | "ma_vat" | "md_vat" | "me_pib" | "mk_vat" | "mr_nif" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "np_pan" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sn_ninea" | "sr_fin" | "sv_nit" | "th_vat" | "tj_tin" | "tr_tin" | "tw_vat" | "tz_vat" | "ua_vat" | "ug_tin" | "us_ein" | "uy_ruc" | "uz_tin" | "uz_vat" | "ve_rif" | "vn_tin" | "za_vat" | "zm_tin" | "zw_tin"; value: string; }[]; /** @description ID of the test clock to attach to the customer. */ @@ -36582,6 +36992,7 @@ export interface operations { account_holder_type?: "company" | "individual"; account_number: string; country: string; + /** Format: currency */ currency?: string; /** @enum {string} */ object?: "bank_account"; @@ -36827,7 +37238,10 @@ export interface operations { "application/x-www-form-urlencoded": { /** @description The integer amount in **cents (or local equivalent)** to apply to the customer's credit balance. */ amount: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Specifies the [`invoice_credit_balance`](https://stripe.com/docs/api/customers/object#customer_object-invoice_credit_balance) that this transaction will apply to. If the customer's `currency` is not set, it will be updated to this value. */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Specifies the [`invoice_credit_balance`](https://stripe.com/docs/api/customers/object#customer_object-invoice_credit_balance) that this transaction will apply to. If the customer's `currency` is not set, it will be updated to this value. + */ currency: string; /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ description?: string; @@ -37022,6 +37436,7 @@ export interface operations { account_holder_type?: "company" | "individual"; account_number: string; country: string; + /** Format: currency */ currency?: string; /** @enum {string} */ object?: "bank_account"; @@ -37356,6 +37771,7 @@ export interface operations { account_holder_type?: "company" | "individual"; account_number: string; country: string; + /** Format: currency */ currency?: string; /** @enum {string} */ object?: "bank_account"; @@ -37850,7 +38266,10 @@ export interface operations { /** @enum {string} */ type: "eu_bank_transfer" | "gb_bank_transfer" | "jp_bank_transfer" | "mx_bank_transfer" | "us_bank_transfer"; }; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; @@ -38060,6 +38479,7 @@ export interface operations { account_holder_type?: "company" | "individual"; account_number: string; country: string; + /** Format: currency */ currency?: string; /** @enum {string} */ object?: "bank_account"; @@ -38396,6 +38816,7 @@ export interface operations { price?: string; /** one_time_price_data_with_negative_amounts */ price_data?: { + /** Format: currency */ currency: string; product: string; /** @enum {string} */ @@ -38451,7 +38872,10 @@ export interface operations { collection_method?: "charge_automatically" | "send_invoice"; /** @description The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription. This field has been deprecated and will be removed in a future API version. Use `discounts` instead. */ coupon?: string; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency?: string; /** @description Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`. */ days_until_due?: number; @@ -38498,6 +38922,7 @@ export interface operations { price?: string; /** recurring_price_data */ price_data?: { + /** Format: currency */ currency: string; product: string; /** recurring_adhoc */ @@ -38724,6 +39149,7 @@ export interface operations { price?: string; /** one_time_price_data_with_negative_amounts */ price_data?: { + /** Format: currency */ currency: string; product: string; /** @enum {string} */ @@ -38828,6 +39254,7 @@ export interface operations { price?: string; /** recurring_price_data */ price_data?: { + /** Format: currency */ currency: string; product: string; /** recurring_adhoc */ @@ -39184,10 +39611,10 @@ export interface operations { /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; /** - * @description Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, or `za_vat` + * @description Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `ba_tin`, `bb_tin`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kh_tin`, `kr_brn`, `kz_bin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin` * @enum {string} */ - type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "by_tin" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "li_vat" | "ma_vat" | "md_vat" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "tz_vat" | "ua_vat" | "us_ein" | "uy_ruc" | "uz_tin" | "uz_vat" | "ve_rif" | "vn_tin" | "za_vat"; + type: "ad_nrt" | "ae_trn" | "al_tin" | "am_tin" | "ao_tin" | "ar_cuit" | "au_abn" | "au_arn" | "ba_tin" | "bb_tin" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "bs_tin" | "by_tin" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "cd_nif" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "gn_nif" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kh_tin" | "kr_brn" | "kz_bin" | "li_uid" | "li_vat" | "ma_vat" | "md_vat" | "me_pib" | "mk_vat" | "mr_nif" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "np_pan" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sn_ninea" | "sr_fin" | "sv_nit" | "th_vat" | "tj_tin" | "tr_tin" | "tw_vat" | "tz_vat" | "ua_vat" | "ug_tin" | "us_ein" | "uy_ruc" | "uz_tin" | "uz_vat" | "ve_rif" | "vn_tin" | "za_vat" | "zm_tin" | "zw_tin"; /** @description Value of the tax ID. */ value: string; }; @@ -39463,6 +39890,10 @@ export interface operations { }; }[]; }; + /** visa_compliance */ + visa_compliance?: { + fee_acknowledged?: boolean; + }; } | ""; product_description?: string; receipt?: string; @@ -41057,7 +41488,7 @@ export interface operations { /** @description The PaymentMethod to insert into the forwarded request. Forwarding previously consumed PaymentMethods is allowed. */ payment_method: string; /** @description The field kinds to be replaced in the forwarded request. */ - replacements: ("card_cvc" | "card_expiry" | "card_number" | "cardholder_name")[]; + replacements: ("card_cvc" | "card_expiry" | "card_number" | "cardholder_name" | "request_signature")[]; /** * request_param * @description The request body and headers to be sent to the destination endpoint. @@ -41804,7 +42235,10 @@ export interface operations { "application/x-www-form-urlencoded": { /** @description The integer amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. Passing in a negative `amount` will reduce the `amount_due` on the invoice. */ amount?: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency?: string; /** @description The ID of the customer who will be billed when this invoice item is billed. */ customer: string; @@ -41843,6 +42277,7 @@ export interface operations { * @description Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required. */ price_data?: { + /** Format: currency */ currency: string; product: string; /** @enum {string} */ @@ -41980,6 +42415,7 @@ export interface operations { * @description Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required. */ price_data?: { + /** Format: currency */ currency: string; product: string; /** @enum {string} */ @@ -42178,7 +42614,10 @@ export interface operations { * @enum {string} */ collection_method?: "charge_automatically" | "send_invoice"; - /** @description The currency to create this invoice in. Defaults to that of `customer` if not specified. */ + /** + * Format: currency + * @description The currency to create this invoice in. Defaults to that of `customer` if not specified. + */ currency?: string; /** @description A list of up to 4 custom fields to be displayed on the invoice. */ custom_fields?: { @@ -42355,6 +42794,7 @@ export interface operations { /** fixed_amount */ fixed_amount?: { amount: number; + /** Format: currency */ currency: string; currency_options?: { [key: string]: { @@ -42452,7 +42892,10 @@ export interface operations { }; /** @description The ID of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead. */ coupon?: string; - /** @description The currency to preview this invoice in. Defaults to that of `customer` if not specified. */ + /** + * Format: currency + * @description The currency to preview this invoice in. Defaults to that of `customer` if not specified. + */ currency?: string; /** @description The identifier of the customer whose upcoming invoice you'd like to retrieve. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set. */ customer?: string; @@ -42490,7 +42933,7 @@ export interface operations { tax_exempt?: "" | "exempt" | "none" | "reverse"; tax_ids?: { /** @enum {string} */ - type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "by_tin" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "li_vat" | "ma_vat" | "md_vat" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "tz_vat" | "ua_vat" | "us_ein" | "uy_ruc" | "uz_tin" | "uz_vat" | "ve_rif" | "vn_tin" | "za_vat"; + type: "ad_nrt" | "ae_trn" | "al_tin" | "am_tin" | "ao_tin" | "ar_cuit" | "au_abn" | "au_arn" | "ba_tin" | "bb_tin" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "bs_tin" | "by_tin" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "cd_nif" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "gn_nif" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kh_tin" | "kr_brn" | "kz_bin" | "li_uid" | "li_vat" | "ma_vat" | "md_vat" | "me_pib" | "mk_vat" | "mr_nif" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "np_pan" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sn_ninea" | "sr_fin" | "sv_nit" | "th_vat" | "tj_tin" | "tr_tin" | "tw_vat" | "tz_vat" | "ua_vat" | "ug_tin" | "us_ein" | "uy_ruc" | "uz_tin" | "uz_vat" | "ve_rif" | "vn_tin" | "za_vat" | "zm_tin" | "zw_tin"; value: string; }[]; }; @@ -42505,6 +42948,7 @@ export interface operations { /** @description List of invoice items to add or update in the upcoming invoice preview (up to 250). */ invoice_items?: { amount?: number; + /** Format: currency */ currency?: string; description?: string; discountable?: boolean; @@ -42527,6 +42971,7 @@ export interface operations { price?: string; /** one_time_price_data */ price_data?: { + /** Format: currency */ currency: string; product: string; /** @enum {string} */ @@ -42579,6 +43024,7 @@ export interface operations { price?: string; /** one_time_price_data_with_negative_amounts */ price_data?: { + /** Format: currency */ currency: string; product: string; /** @enum {string} */ @@ -42645,6 +43091,7 @@ export interface operations { price?: string; /** recurring_price_data */ price_data?: { + /** Format: currency */ currency: string; product: string; /** recurring_adhoc */ @@ -42711,6 +43158,7 @@ export interface operations { price?: string; /** recurring_price_data */ price_data?: { + /** Format: currency */ currency: string; product: string; /** recurring_adhoc */ @@ -42866,7 +43314,7 @@ export interface operations { tax_exempt?: "" | "exempt" | "none" | "reverse"; tax_ids?: { /** @enum {string} */ - type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "by_tin" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "li_vat" | "ma_vat" | "md_vat" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "tz_vat" | "ua_vat" | "us_ein" | "uy_ruc" | "uz_tin" | "uz_vat" | "ve_rif" | "vn_tin" | "za_vat"; + type: "ad_nrt" | "ae_trn" | "al_tin" | "am_tin" | "ao_tin" | "ar_cuit" | "au_abn" | "au_arn" | "ba_tin" | "bb_tin" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "bs_tin" | "by_tin" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "cd_nif" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "gn_nif" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kh_tin" | "kr_brn" | "kz_bin" | "li_uid" | "li_vat" | "ma_vat" | "md_vat" | "me_pib" | "mk_vat" | "mr_nif" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "np_pan" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sn_ninea" | "sr_fin" | "sv_nit" | "th_vat" | "tj_tin" | "tr_tin" | "tw_vat" | "tz_vat" | "ua_vat" | "ug_tin" | "us_ein" | "uy_ruc" | "uz_tin" | "uz_vat" | "ve_rif" | "vn_tin" | "za_vat" | "zm_tin" | "zw_tin"; value: string; }[]; }; @@ -42881,6 +43329,7 @@ export interface operations { /** @description List of invoice items to add or update in the upcoming invoice preview (up to 250). */ invoice_items?: { amount?: number; + /** Format: currency */ currency?: string; description?: string; discountable?: boolean; @@ -42903,6 +43352,7 @@ export interface operations { price?: string; /** one_time_price_data */ price_data?: { + /** Format: currency */ currency: string; product: string; /** @enum {string} */ @@ -42946,6 +43396,7 @@ export interface operations { price?: string; /** one_time_price_data_with_negative_amounts */ price_data?: { + /** Format: currency */ currency: string; product: string; /** @enum {string} */ @@ -43012,6 +43463,7 @@ export interface operations { price?: string; /** recurring_price_data */ price_data?: { + /** Format: currency */ currency: string; product: string; /** recurring_adhoc */ @@ -43085,6 +43537,7 @@ export interface operations { price?: string; /** recurring_price_data */ price_data?: { + /** Format: currency */ currency: string; product: string; /** recurring_adhoc */ @@ -43131,6 +43584,7 @@ export interface operations { price?: string; /** recurring_price_data */ price_data?: { + /** Format: currency */ currency: string; product: string; /** recurring_adhoc */ @@ -43239,7 +43693,7 @@ export interface operations { tax_exempt?: "" | "exempt" | "none" | "reverse"; tax_ids?: { /** @enum {string} */ - type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "by_tin" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "li_vat" | "ma_vat" | "md_vat" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "tz_vat" | "ua_vat" | "us_ein" | "uy_ruc" | "uz_tin" | "uz_vat" | "ve_rif" | "vn_tin" | "za_vat"; + type: "ad_nrt" | "ae_trn" | "al_tin" | "am_tin" | "ao_tin" | "ar_cuit" | "au_abn" | "au_arn" | "ba_tin" | "bb_tin" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "bs_tin" | "by_tin" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "cd_nif" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "gn_nif" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kh_tin" | "kr_brn" | "kz_bin" | "li_uid" | "li_vat" | "ma_vat" | "md_vat" | "me_pib" | "mk_vat" | "mr_nif" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "np_pan" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sn_ninea" | "sr_fin" | "sv_nit" | "th_vat" | "tj_tin" | "tr_tin" | "tw_vat" | "tz_vat" | "ua_vat" | "ug_tin" | "us_ein" | "uy_ruc" | "uz_tin" | "uz_vat" | "ve_rif" | "vn_tin" | "za_vat" | "zm_tin" | "zw_tin"; value: string; }[]; }; @@ -43256,6 +43710,7 @@ export interface operations { /** @description List of invoice items to add or update in the upcoming invoice preview (up to 250). */ invoice_items?: { amount?: number; + /** Format: currency */ currency?: string; description?: string; discountable?: boolean; @@ -43278,6 +43733,7 @@ export interface operations { price?: string; /** one_time_price_data */ price_data?: { + /** Format: currency */ currency: string; product: string; /** @enum {string} */ @@ -43323,6 +43779,7 @@ export interface operations { price?: string; /** one_time_price_data_with_negative_amounts */ price_data?: { + /** Format: currency */ currency: string; product: string; /** @enum {string} */ @@ -43389,6 +43846,7 @@ export interface operations { price?: string; /** recurring_price_data */ price_data?: { + /** Format: currency */ currency: string; product: string; /** recurring_adhoc */ @@ -43464,6 +43922,7 @@ export interface operations { price?: string; /** recurring_price_data */ price_data?: { + /** Format: currency */ currency: string; product: string; /** recurring_adhoc */ @@ -43510,6 +43969,7 @@ export interface operations { price?: string; /** recurring_price_data */ price_data?: { + /** Format: currency */ currency: string; product: string; /** recurring_adhoc */ @@ -43812,6 +44272,7 @@ export interface operations { /** fixed_amount */ fixed_amount?: { amount: number; + /** Format: currency */ currency: string; currency_options?: { [key: string]: { @@ -43953,6 +44414,7 @@ export interface operations { price?: string; /** one_time_price_data_with_product_data */ price_data?: { + /** Format: currency */ currency: string; product?: string; /** product_data */ @@ -44160,6 +44622,7 @@ export interface operations { * @description Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required. */ price_data?: { + /** Format: currency */ currency: string; product?: string; /** product_data */ @@ -44441,6 +44904,7 @@ export interface operations { price?: string; /** one_time_price_data_with_product_data */ price_data?: { + /** Format: currency */ currency: string; product?: string; /** product_data */ @@ -47021,7 +47485,10 @@ export interface operations { * * If the provided ConfirmationToken contains properties that are also being provided in this request, such as `payment_method`, then the values in this request will take precedence. */ confirmation_token?: string; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description ID of the Customer this PaymentIntent belongs to, if one exists. * @@ -47288,7 +47755,9 @@ export interface operations { } | ""; bacs_debit?: { /** payment_method_options_mandate_options_param */ - mandate_options?: Record; + mandate_options?: { + reference_prefix?: string | ""; + }; /** @enum {string} */ setup_future_usage?: "" | "none" | "off_session" | "on_session"; } | ""; @@ -47532,7 +48001,9 @@ export interface operations { } | ""; sepa_debit?: { /** payment_method_options_mandate_options_param */ - mandate_options?: Record; + mandate_options?: { + reference_prefix?: string | ""; + }; /** @enum {string} */ setup_future_usage?: "" | "none" | "off_session" | "on_session"; } | ""; @@ -47791,7 +48262,10 @@ export interface operations { * @enum {string} */ capture_method?: "automatic" | "automatic_async" | "manual"; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency?: string; /** @description ID of the Customer this PaymentIntent belongs to, if one exists. * @@ -48031,7 +48505,9 @@ export interface operations { } | ""; bacs_debit?: { /** payment_method_options_mandate_options_param */ - mandate_options?: Record; + mandate_options?: { + reference_prefix?: string | ""; + }; /** @enum {string} */ setup_future_usage?: "" | "none" | "off_session" | "on_session"; } | ""; @@ -48275,7 +48751,9 @@ export interface operations { } | ""; sepa_debit?: { /** payment_method_options_mandate_options_param */ - mandate_options?: Record; + mandate_options?: { + reference_prefix?: string | ""; + }; /** @enum {string} */ setup_future_usage?: "" | "none" | "off_session" | "on_session"; } | ""; @@ -48423,7 +48901,10 @@ export interface operations { * * When you omit the amount, it defaults to the remaining amount requested on the PaymentIntent. */ amount?: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency?: string; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; @@ -48836,7 +49317,9 @@ export interface operations { } | ""; bacs_debit?: { /** payment_method_options_mandate_options_param */ - mandate_options?: Record; + mandate_options?: { + reference_prefix?: string | ""; + }; /** @enum {string} */ setup_future_usage?: "" | "none" | "off_session" | "on_session"; } | ""; @@ -49080,7 +49563,9 @@ export interface operations { } | ""; sepa_debit?: { /** payment_method_options_mandate_options_param */ - mandate_options?: Record; + mandate_options?: { + reference_prefix?: string | ""; + }; /** @enum {string} */ setup_future_usage?: "" | "none" | "off_session" | "on_session"; } | ""; @@ -49430,7 +49915,10 @@ export interface operations { /** @enum {string} */ terms_of_service?: "none" | "required"; }; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies) and supported by each line item's price. */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies) and supported by each line item's price. + */ currency?: string; /** @description Collect additional information from your customer using custom fields. Up to 3 fields are supported. */ custom_fields?: { @@ -49915,6 +50403,7 @@ export interface operations { metadata?: { [key: string]: string; } | ""; + trial_period_days?: number | ""; trial_settings?: { /** end_behavior */ end_behavior: { @@ -52034,7 +52523,10 @@ export interface operations { "application/x-www-form-urlencoded": { /** @description A positive integer in cents representing how much to payout. */ amount: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ description?: string; @@ -52336,7 +52828,10 @@ export interface operations { * @enum {string} */ billing_scheme?: "per_unit" | "tiered"; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; @@ -52643,7 +53138,10 @@ export interface operations { * @enum {string} */ billing_scheme?: "per_unit" | "tiered"; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description Prices defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies). */ currency_options?: { @@ -53044,6 +53542,7 @@ export interface operations { * @description Data used to generate a new [Price](https://stripe.com/docs/api/prices) object. This Price will be set as the default price for this product. */ default_price_data?: { + /** Format: currency */ currency: string; currency_options?: { [key: string]: { @@ -53642,6 +54141,7 @@ export interface operations { }; first_time_transaction?: boolean; minimum_amount?: number; + /** Format: currency */ minimum_amount_currency?: string; }; }; @@ -53906,6 +54406,7 @@ export interface operations { price?: string; /** price_data */ price_data?: { + /** Format: currency */ currency: string; product: string; /** recurring_adhoc */ @@ -54092,6 +54593,7 @@ export interface operations { price?: string; /** price_data */ price_data?: { + /** Format: currency */ currency: string; product: string; /** recurring_adhoc */ @@ -55014,7 +55516,10 @@ export interface operations { amount?: number; /** @description The identifier of the charge to refund. */ charge?: string; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency?: string; /** @description Customer whose customer balance to refund from. */ customer?: string; @@ -55263,6 +55768,7 @@ export interface operations { parameters?: { columns?: string[]; connected_account?: string; + /** Format: currency */ currency?: string; /** Format: unix-time */ interval_end?: number; @@ -55952,7 +56458,9 @@ export interface operations { /** setup_intent_payment_method_options_param */ bacs_debit?: { /** payment_method_options_mandate_options_param */ - mandate_options?: Record; + mandate_options?: { + reference_prefix?: string | ""; + }; }; /** setup_intent_param */ card?: { @@ -55961,6 +56469,7 @@ export interface operations { amount: number; /** @enum {string} */ amount_type: "fixed" | "maximum"; + /** Format: currency */ currency: string; description?: string; /** Format: unix-time */ @@ -56011,7 +56520,9 @@ export interface operations { /** setup_intent_payment_method_options_param */ sepa_debit?: { /** payment_method_options_mandate_options_param */ - mandate_options?: Record; + mandate_options?: { + reference_prefix?: string | ""; + }; }; /** setup_intent_payment_method_options_param */ us_bank_account?: { @@ -56048,6 +56559,7 @@ export interface operations { */ single_use?: { amount: number; + /** Format: currency */ currency: string; }; /** @@ -56349,7 +56861,9 @@ export interface operations { /** setup_intent_payment_method_options_param */ bacs_debit?: { /** payment_method_options_mandate_options_param */ - mandate_options?: Record; + mandate_options?: { + reference_prefix?: string | ""; + }; }; /** setup_intent_param */ card?: { @@ -56358,6 +56872,7 @@ export interface operations { amount: number; /** @enum {string} */ amount_type: "fixed" | "maximum"; + /** Format: currency */ currency: string; description?: string; /** Format: unix-time */ @@ -56408,7 +56923,9 @@ export interface operations { /** setup_intent_payment_method_options_param */ sepa_debit?: { /** payment_method_options_mandate_options_param */ - mandate_options?: Record; + mandate_options?: { + reference_prefix?: string | ""; + }; }; /** setup_intent_payment_method_options_param */ us_bank_account?: { @@ -56745,7 +57262,9 @@ export interface operations { /** setup_intent_payment_method_options_param */ bacs_debit?: { /** payment_method_options_mandate_options_param */ - mandate_options?: Record; + mandate_options?: { + reference_prefix?: string | ""; + }; }; /** setup_intent_param */ card?: { @@ -56754,6 +57273,7 @@ export interface operations { amount: number; /** @enum {string} */ amount_type: "fixed" | "maximum"; + /** Format: currency */ currency: string; description?: string; /** Format: unix-time */ @@ -56804,7 +57324,9 @@ export interface operations { /** setup_intent_payment_method_options_param */ sepa_debit?: { /** payment_method_options_mandate_options_param */ - mandate_options?: Record; + mandate_options?: { + reference_prefix?: string | ""; + }; }; /** setup_intent_payment_method_options_param */ us_bank_account?: { @@ -57007,6 +57529,7 @@ export interface operations { */ fixed_amount?: { amount: number; + /** Format: currency */ currency: string; currency_options?: { [key: string]: { @@ -57259,7 +57782,10 @@ export interface operations { "application/x-www-form-urlencoded": { /** @description Amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for `single_use` sources. Not supported for `receiver` type sources, where charge amount may not be specified until funds land. */ amount?: number; - /** @description Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) associated with the source. This is the currency for which the source will be chargeable once ready. */ + /** + * Format: currency + * @description Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) associated with the source. This is the currency for which the source will be chargeable once ready. + */ currency?: string; /** @description The `Customer` to whom the original source is attached to. Must be set when the original source is not a `Source` (e.g., `Card`). */ customer?: string; @@ -57298,6 +57824,7 @@ export interface operations { user_agent?: string; }; amount?: number | ""; + /** Format: currency */ currency?: string; /** @enum {string} */ interval?: "one_time" | "scheduled" | "variable"; @@ -57349,6 +57876,7 @@ export interface operations { source_order?: { items?: { amount?: number; + /** Format: currency */ currency?: string; description?: string; parent?: string; @@ -57489,6 +58017,7 @@ export interface operations { user_agent?: string; }; amount?: number | ""; + /** Format: currency */ currency?: string; /** @enum {string} */ interval?: "one_time" | "scheduled" | "variable"; @@ -57524,6 +58053,7 @@ export interface operations { source_order?: { items?: { amount?: number; + /** Format: currency */ currency?: string; description?: string; parent?: string; @@ -57844,6 +58374,7 @@ export interface operations { * @description Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. */ price_data?: { + /** Format: currency */ currency: string; product: string; /** recurring_adhoc */ @@ -57984,6 +58515,7 @@ export interface operations { * @description Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required. */ price_data?: { + /** Format: currency */ currency: string; product: string; /** recurring_adhoc */ @@ -58350,6 +58882,7 @@ export interface operations { price?: string; /** one_time_price_data_with_negative_amounts */ price_data?: { + /** Format: currency */ currency: string; product: string; /** @enum {string} */ @@ -58381,6 +58914,7 @@ export interface operations { /** @enum {string} */ collection_method?: "charge_automatically" | "send_invoice"; coupon?: string; + /** Format: currency */ currency?: string; default_payment_method?: string; default_tax_rates?: string[] | ""; @@ -58418,6 +58952,7 @@ export interface operations { price?: string; /** recurring_price_data */ price_data?: { + /** Format: currency */ currency: string; product: string; /** recurring_adhoc */ @@ -58592,6 +59127,7 @@ export interface operations { price?: string; /** one_time_price_data_with_negative_amounts */ price_data?: { + /** Format: currency */ currency: string; product: string; /** @enum {string} */ @@ -58658,6 +59194,7 @@ export interface operations { price?: string; /** recurring_price_data */ price_data?: { + /** Format: currency */ currency: string; product: string; /** recurring_adhoc */ @@ -58910,6 +59447,7 @@ export interface operations { price?: string; /** one_time_price_data_with_negative_amounts */ price_data?: { + /** Format: currency */ currency: string; product: string; /** @enum {string} */ @@ -58976,7 +59514,10 @@ export interface operations { collection_method?: "charge_automatically" | "send_invoice"; /** @description The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription. This field has been deprecated and will be removed in a future API version. Use `discounts` instead. */ coupon?: string; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency?: string; /** @description The identifier of the customer to subscribe. */ customer: string; @@ -59027,6 +59568,7 @@ export interface operations { price?: string; /** recurring_price_data */ price_data?: { + /** Format: currency */ currency: string; product: string; /** recurring_adhoc */ @@ -59307,6 +59849,7 @@ export interface operations { price?: string; /** one_time_price_data_with_negative_amounts */ price_data?: { + /** Format: currency */ currency: string; product: string; /** @enum {string} */ @@ -59413,6 +59956,7 @@ export interface operations { price?: string; /** recurring_price_data */ price_data?: { + /** Format: currency */ currency: string; product: string; /** recurring_adhoc */ @@ -59731,7 +60275,10 @@ export interface operations { requestBody: { content: { "application/x-www-form-urlencoded": { - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description The ID of an existing customer to use for this calculation. If provided, the customer's address and tax IDs are copied to `customer_details`. */ customer?: string; @@ -59754,7 +60301,7 @@ export interface operations { ip_address?: string; tax_ids?: { /** @enum {string} */ - type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "by_tin" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "li_vat" | "ma_vat" | "md_vat" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "tz_vat" | "ua_vat" | "us_ein" | "uy_ruc" | "uz_tin" | "uz_vat" | "ve_rif" | "vn_tin" | "za_vat"; + type: "ad_nrt" | "ae_trn" | "al_tin" | "am_tin" | "ao_tin" | "ar_cuit" | "au_abn" | "au_arn" | "ba_tin" | "bb_tin" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "bs_tin" | "by_tin" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "cd_nif" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "gn_nif" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kh_tin" | "kr_brn" | "kz_bin" | "li_uid" | "li_vat" | "ma_vat" | "md_vat" | "me_pib" | "mk_vat" | "mr_nif" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "np_pan" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sn_ninea" | "sr_fin" | "sv_nit" | "th_vat" | "tj_tin" | "tr_tin" | "tw_vat" | "tz_vat" | "ua_vat" | "ug_tin" | "us_ein" | "uy_ruc" | "uz_tin" | "uz_vat" | "ve_rif" | "vn_tin" | "za_vat" | "zm_tin" | "zw_tin"; value: string; }[]; /** @enum {string} */ @@ -59997,6 +60544,21 @@ export interface operations { /** @enum {string} */ type: "standard"; }; + /** default */ + al?: { + /** @enum {string} */ + type: "standard"; + }; + /** simplified */ + am?: { + /** @enum {string} */ + type: "simplified"; + }; + /** default */ + ao?: { + /** @enum {string} */ + type: "standard"; + }; /** europe */ at?: { /** standard */ @@ -60012,6 +60574,16 @@ export interface operations { /** @enum {string} */ type: "standard"; }; + /** default */ + ba?: { + /** @enum {string} */ + type: "standard"; + }; + /** default */ + bb?: { + /** @enum {string} */ + type: "standard"; + }; /** europe */ be?: { /** standard */ @@ -60037,6 +60609,11 @@ export interface operations { /** @enum {string} */ type: "standard"; }; + /** default */ + bs?: { + /** @enum {string} */ + type: "standard"; + }; /** simplified */ by?: { /** @enum {string} */ @@ -60052,6 +60629,11 @@ export interface operations { type: "province_standard" | "simplified" | "standard"; }; /** default */ + cd?: { + /** @enum {string} */ + type: "standard"; + }; + /** default */ ch?: { /** @enum {string} */ type: "standard"; @@ -60171,6 +60753,11 @@ export interface operations { /** @enum {string} */ type: "simplified"; }; + /** default */ + gn?: { + /** @enum {string} */ + type: "standard"; + }; /** europe */ gr?: { /** standard */ @@ -60242,6 +60829,11 @@ export interface operations { type: "simplified"; }; /** simplified */ + kh?: { + /** @enum {string} */ + type: "simplified"; + }; + /** simplified */ kr?: { /** @enum {string} */ type: "simplified"; @@ -60291,6 +60883,21 @@ export interface operations { /** @enum {string} */ type: "simplified"; }; + /** default */ + me?: { + /** @enum {string} */ + type: "standard"; + }; + /** default */ + mk?: { + /** @enum {string} */ + type: "standard"; + }; + /** default */ + mr?: { + /** @enum {string} */ + type: "standard"; + }; /** europe */ mt?: { /** standard */ @@ -60331,6 +60938,11 @@ export interface operations { /** @enum {string} */ type: "standard"; }; + /** simplified */ + np?: { + /** @enum {string} */ + type: "simplified"; + }; /** default */ nz?: { /** @enum {string} */ @@ -60341,6 +60953,11 @@ export interface operations { /** @enum {string} */ type: "standard"; }; + /** simplified */ + pe?: { + /** @enum {string} */ + type: "simplified"; + }; /** europe */ pl?: { /** standard */ @@ -60422,11 +61039,26 @@ export interface operations { type: "ioss" | "oss_non_union" | "oss_union" | "standard"; }; /** simplified */ + sn?: { + /** @enum {string} */ + type: "simplified"; + }; + /** default */ + sr?: { + /** @enum {string} */ + type: "standard"; + }; + /** simplified */ th?: { /** @enum {string} */ type: "simplified"; }; /** simplified */ + tj?: { + /** @enum {string} */ + type: "simplified"; + }; + /** simplified */ tr?: { /** @enum {string} */ type: "simplified"; @@ -60436,6 +61068,11 @@ export interface operations { /** @enum {string} */ type: "simplified"; }; + /** simplified */ + ug?: { + /** @enum {string} */ + type: "simplified"; + }; /** united_states */ us?: { /** local_amusement_tax */ @@ -60458,6 +61095,11 @@ export interface operations { /** @enum {string} */ type: "local_amusement_tax" | "local_lease_tax" | "state_communications_tax" | "state_retail_delivery_fee" | "state_sales_tax"; }; + /** default */ + uy?: { + /** @enum {string} */ + type: "standard"; + }; /** simplified */ uz?: { /** @enum {string} */ @@ -60473,6 +61115,16 @@ export interface operations { /** @enum {string} */ type: "standard"; }; + /** simplified */ + zm?: { + /** @enum {string} */ + type: "simplified"; + }; + /** default */ + zw?: { + /** @enum {string} */ + type: "standard"; + }; }; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; @@ -61069,10 +61721,10 @@ export interface operations { type: "account" | "application" | "customer" | "self"; }; /** - * @description Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, or `za_vat` + * @description Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `ba_tin`, `bb_tin`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kh_tin`, `kr_brn`, `kz_bin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin` * @enum {string} */ - type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "by_tin" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "li_vat" | "ma_vat" | "md_vat" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "tz_vat" | "ua_vat" | "us_ein" | "uy_ruc" | "uz_tin" | "uz_vat" | "ve_rif" | "vn_tin" | "za_vat"; + type: "ad_nrt" | "ae_trn" | "al_tin" | "am_tin" | "ao_tin" | "ar_cuit" | "au_abn" | "au_arn" | "ba_tin" | "bb_tin" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "bs_tin" | "by_tin" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "cd_nif" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "gn_nif" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kh_tin" | "kr_brn" | "kz_bin" | "li_uid" | "li_vat" | "ma_vat" | "md_vat" | "me_pib" | "mk_vat" | "mr_nif" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "np_pan" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sn_ninea" | "sr_fin" | "sv_nit" | "th_vat" | "tj_tin" | "tr_tin" | "tw_vat" | "tz_vat" | "ua_vat" | "ug_tin" | "us_ein" | "uy_ruc" | "uz_tin" | "uz_vat" | "ve_rif" | "vn_tin" | "za_vat" | "zm_tin" | "zw_tin"; /** @description Value of the tax ID. */ value: string; }; @@ -62039,7 +62691,7 @@ export interface operations { "application/x-www-form-urlencoded": { /** * optional_fields_address - * @description The full address of the location. If you're updating the `address` field, avoid changing the `country`. If you need to modify the `country` field, create a new `Location` object and re-register any existing readers to that location. + * @description The full address of the location. You can't change the location's `country`. If you need to modify the `country` field, create a new `Location` object and re-register any existing readers to that location. */ address?: { city?: string; @@ -62563,6 +63215,7 @@ export interface operations { * @description Cart */ cart?: { + /** Format: currency */ currency: string; line_items: { amount: number; @@ -62845,7 +63498,10 @@ export interface operations { "application/x-www-form-urlencoded": { /** @description Amount to be used for this test cash balance transaction. A positive integer representing how much to fund in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to fund $1.00 or 100 to fund ¥100, a zero-decimal currency). */ amount: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; @@ -62902,7 +63558,10 @@ export interface operations { authorization_method?: "chip" | "contactless" | "keyed_in" | "online" | "swipe"; /** @description Card associated with this authorization. */ card: string; - /** @description The currency of the authorization. If not provided, defaults to the currency of the card. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description The currency of the authorization. If not provided, defaults to the currency of the card. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency?: string; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; @@ -62963,7 +63622,10 @@ export interface operations { is_amount_controllable?: boolean; /** @description The total amount to attempt to authorize. This amount is in the provided merchant currency, and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ merchant_amount?: number; - /** @description The currency of the authorization. If not provided, defaults to the currency of the card. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description The currency of the authorization. If not provided, defaults to the currency of the card. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ merchant_currency?: string; /** * merchant_data_specs @@ -63747,7 +64409,10 @@ export interface operations { bin: string; /** @description The date that the transactions are cleared and posted to user's accounts. */ clearing_date: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; @@ -63799,7 +64464,10 @@ export interface operations { amount: number; /** @description Card associated with this transaction. */ card: string; - /** @description The currency of the capture. If not provided, defaults to the currency of the card. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description The currency of the capture. If not provided, defaults to the currency of the card. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency?: string; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; @@ -63940,7 +64608,10 @@ export interface operations { amount: number; /** @description Card associated with this unlinked refund transaction. */ card: string; - /** @description The currency of the unlinked refund. If not provided, defaults to the currency of the card. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description The currency of the unlinked refund. If not provided, defaults to the currency of the card. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency?: string; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; @@ -64906,7 +65577,10 @@ export interface operations { "application/x-www-form-urlencoded": { /** @description Amount (in cents) to be transferred. */ amount: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ description?: string; @@ -64969,7 +65643,10 @@ export interface operations { "application/x-www-form-urlencoded": { /** @description Amount (in cents) to be transferred. */ amount: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ description?: string; @@ -65200,6 +65877,7 @@ export interface operations { /** @enum {string} */ account_type?: "checking" | "futsu" | "savings" | "toza"; country: string; + /** Format: currency */ currency?: string; payment_method?: string; routing_number?: string; @@ -65328,6 +66006,7 @@ export interface operations { }; /** relationship_specs */ relationship?: { + authorizer?: boolean; director?: boolean; executive?: boolean; legal_guardian?: boolean; @@ -65738,7 +66417,10 @@ export interface operations { "application/x-www-form-urlencoded": { /** @description A positive integer in cents (or local equivalent) representing how much to transfer. */ amount?: number; - /** @description Three-letter [ISO code for currency](https://www.iso.org/iso-4217-currency-codes.html) in lowercase. Must be a [supported currency](https://docs.stripe.com/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO code for currency](https://www.iso.org/iso-4217-currency-codes.html) in lowercase. Must be a [supported currency](https://docs.stripe.com/currencies). + */ currency: string; /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ description?: string; @@ -66858,7 +67540,10 @@ export interface operations { "application/x-www-form-urlencoded": { /** @description Amount (in cents) to be transferred. */ amount: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ description?: string; @@ -67053,7 +67738,10 @@ export interface operations { "application/x-www-form-urlencoded": { /** @description Amount (in cents) to be transferred. */ amount: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description ID of the customer to whom the OutboundPayment is sent. Must match the Customer attached to the `destination_payment_method` passed in. */ customer?: string; @@ -67295,7 +67983,10 @@ export interface operations { "application/x-www-form-urlencoded": { /** @description Amount (in cents) to be transferred. */ amount: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ description?: string; @@ -67910,7 +68601,7 @@ export interface operations { * @description Events sent to this endpoint will be generated with this Stripe Version instead of your account's default Stripe Version. * @enum {string} */ - api_version?: "2011-01-01" | "2011-06-21" | "2011-06-28" | "2011-08-01" | "2011-09-15" | "2011-11-17" | "2012-02-23" | "2012-03-25" | "2012-06-18" | "2012-06-28" | "2012-07-09" | "2012-09-24" | "2012-10-26" | "2012-11-07" | "2013-02-11" | "2013-02-13" | "2013-07-05" | "2013-08-12" | "2013-08-13" | "2013-10-29" | "2013-12-03" | "2014-01-31" | "2014-03-13" | "2014-03-28" | "2014-05-19" | "2014-06-13" | "2014-06-17" | "2014-07-22" | "2014-07-26" | "2014-08-04" | "2014-08-20" | "2014-09-08" | "2014-10-07" | "2014-11-05" | "2014-11-20" | "2014-12-08" | "2014-12-17" | "2014-12-22" | "2015-01-11" | "2015-01-26" | "2015-02-10" | "2015-02-16" | "2015-02-18" | "2015-03-24" | "2015-04-07" | "2015-06-15" | "2015-07-07" | "2015-07-13" | "2015-07-28" | "2015-08-07" | "2015-08-19" | "2015-09-03" | "2015-09-08" | "2015-09-23" | "2015-10-01" | "2015-10-12" | "2015-10-16" | "2016-02-03" | "2016-02-19" | "2016-02-22" | "2016-02-23" | "2016-02-29" | "2016-03-07" | "2016-06-15" | "2016-07-06" | "2016-10-19" | "2017-01-27" | "2017-02-14" | "2017-04-06" | "2017-05-25" | "2017-06-05" | "2017-08-15" | "2017-12-14" | "2018-01-23" | "2018-02-05" | "2018-02-06" | "2018-02-28" | "2018-05-21" | "2018-07-27" | "2018-08-23" | "2018-09-06" | "2018-09-24" | "2018-10-31" | "2018-11-08" | "2019-02-11" | "2019-02-19" | "2019-03-14" | "2019-05-16" | "2019-08-14" | "2019-09-09" | "2019-10-08" | "2019-10-17" | "2019-11-05" | "2019-12-03" | "2020-03-02" | "2020-08-27" | "2022-08-01" | "2022-11-15" | "2023-08-16" | "2023-10-16" | "2024-04-10" | "2024-06-20" | "2024-09-30.acacia" | "2024-10-28.acacia"; + api_version?: "2011-01-01" | "2011-06-21" | "2011-06-28" | "2011-08-01" | "2011-09-15" | "2011-11-17" | "2012-02-23" | "2012-03-25" | "2012-06-18" | "2012-06-28" | "2012-07-09" | "2012-09-24" | "2012-10-26" | "2012-11-07" | "2013-02-11" | "2013-02-13" | "2013-07-05" | "2013-08-12" | "2013-08-13" | "2013-10-29" | "2013-12-03" | "2014-01-31" | "2014-03-13" | "2014-03-28" | "2014-05-19" | "2014-06-13" | "2014-06-17" | "2014-07-22" | "2014-07-26" | "2014-08-04" | "2014-08-20" | "2014-09-08" | "2014-10-07" | "2014-11-05" | "2014-11-20" | "2014-12-08" | "2014-12-17" | "2014-12-22" | "2015-01-11" | "2015-01-26" | "2015-02-10" | "2015-02-16" | "2015-02-18" | "2015-03-24" | "2015-04-07" | "2015-06-15" | "2015-07-07" | "2015-07-13" | "2015-07-28" | "2015-08-07" | "2015-08-19" | "2015-09-03" | "2015-09-08" | "2015-09-23" | "2015-10-01" | "2015-10-12" | "2015-10-16" | "2016-02-03" | "2016-02-19" | "2016-02-22" | "2016-02-23" | "2016-02-29" | "2016-03-07" | "2016-06-15" | "2016-07-06" | "2016-10-19" | "2017-01-27" | "2017-02-14" | "2017-04-06" | "2017-05-25" | "2017-06-05" | "2017-08-15" | "2017-12-14" | "2018-01-23" | "2018-02-05" | "2018-02-06" | "2018-02-28" | "2018-05-21" | "2018-07-27" | "2018-08-23" | "2018-09-06" | "2018-09-24" | "2018-10-31" | "2018-11-08" | "2019-02-11" | "2019-02-19" | "2019-03-14" | "2019-05-16" | "2019-08-14" | "2019-09-09" | "2019-10-08" | "2019-10-17" | "2019-11-05" | "2019-12-03" | "2020-03-02" | "2020-08-27" | "2022-08-01" | "2022-11-15" | "2023-08-16" | "2023-10-16" | "2024-04-10" | "2024-06-20" | "2024-09-30.acacia" | "2024-10-28.acacia" | "2024-11-20.acacia" | "2024-12-18.acacia"; /** @description Whether this endpoint should receive events from connected accounts (`true`), or from your account (`false`). Defaults to `false`. */ connect?: boolean; /** @description An optional description of what the webhook is used for. */ diff --git a/packages/openapi-metadata/package.json b/packages/openapi-metadata/package.json index b046efca6..44857af52 100644 --- a/packages/openapi-metadata/package.json +++ b/packages/openapi-metadata/package.json @@ -68,7 +68,7 @@ "devDependencies": { "@types/lodash": "^4.17.13", "@types/node": "^22.10.1", - "@vitest/coverage-v8": "^2.1.6", + "@vitest/coverage-v8": "^2.1.8", "del-cli": "^5.1.0", "esbuild": "^0.24.0", "execa": "^8.0.1", diff --git a/packages/openapi-typescript/examples/digital-ocean-api.ts b/packages/openapi-typescript/examples/digital-ocean-api.ts index 85271084b..1ae505549 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api.ts +++ b/packages/openapi-typescript/examples/digital-ocean-api.ts @@ -220,6 +220,26 @@ export interface paths { patch?: never; trace?: never; }; + "/v2/apps/{app_id}/restart": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Restart an App + * @description Perform a rolling restart of all or specific components in an app. + */ + post: operations["apps_restart"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/v2/apps/{app_id}/components/{component_name}/logs": { parameters: { query?: never; @@ -240,6 +260,26 @@ export interface paths { patch?: never; trace?: never; }; + "/v2/apps/{app_id}/components/{component_name}/exec": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Retrieve Exec URL + * @description Returns a websocket URL that allows sending/receiving console input and output to a component of the active deployment if one exists. + */ + get: operations["apps_get_exec_active_deployment"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/v2/apps/{app_id}/deployments": { parameters: { query?: never; @@ -344,6 +384,26 @@ export interface paths { patch?: never; trace?: never; }; + "/v2/apps/{app_id}/deployments/{deployment_id}/components/{component_name}/exec": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Retrieve Exec URL for Deployment + * @description Returns a websocket URL that allows sending/receiving console input and output to a component of the specified deployment if one exists. + */ + get: operations["apps_get_exec"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/v2/apps/{app_id}/logs": { parameters: { query?: never; @@ -2607,6 +2667,142 @@ export interface paths { patch?: never; trace?: never; }; + "/v2/droplets/autoscale": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List All Autoscale Pools + * @description To list all autoscale pools in your team, send a GET request to `/v2/droplets/autoscale`. + * The response body will be a JSON object with a key of `autoscale_pools` containing an array of autoscale pool objects. + * These each contain the standard autoscale pool attributes. + * + */ + get: operations["autoscalepools_list"]; + put?: never; + /** + * Create a New Autoscale Pool + * @description To create a new autoscale pool, send a POST request to `/v2/droplets/autoscale` setting the required attributes. + * + * The response body will contain a JSON object with a key called `autoscale_pool` containing the standard attributes for the new autoscale pool. + * + */ + post: operations["autoscalepools_create"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/droplets/autoscale/{autoscale_pool_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Retrieve an Existing Autoscale Pool + * @description To show information about an individual autoscale pool, send a GET request to + * `/v2/droplets/autoscale/$AUTOSCALE_POOL_ID`. + * + */ + get: operations["autoscalepools_get"]; + /** + * Update Autoscale Pool + * @description To update the configuration of an existing autoscale pool, send a PUT request to + * `/v2/droplets/autoscale/$AUTOSCALE_POOL_ID`. The request must contain a full representation + * of the autoscale pool including existing attributes. + * + */ + put: operations["autoscalepools_update"]; + post?: never; + /** + * Delete autoscale pool + * @description To destroy an autoscale pool, send a DELETE request to the `/v2/droplets/autoscale/$AUTOSCALE_POOL_ID` endpoint. + * + * A successful response will include a 202 response code and no content. + * + */ + delete: operations["autoscalepools_delete"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/droplets/autoscale/{autoscale_pool_id}/dangerous": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + /** + * Delete autoscale pool and resources + * @description To destroy an autoscale pool and its associated resources (Droplets), + * send a DELETE request to the `/v2/droplets/autoscale/$AUTOSCALE_POOL_ID/dangerous` endpoint. + * + */ + delete: operations["autoscalepools_delete_dangerous"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/droplets/autoscale/{autoscale_pool_id}/members": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List members + * @description To list the Droplets in an autoscale pool, send a GET request to `/v2/droplets/autoscale/$AUTOSCALE_POOL_ID/members`. + * + * The response body will be a JSON object with a key of `droplets`. This will be + * set to an array containing information about each of the Droplets in the autoscale pool. + * + */ + get: operations["autoscalepools_list_members"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/droplets/autoscale/{autoscale_pool_id}/history": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List history events + * @description To list all of the scaling history events of an autoscale pool, send a GET request to `/v2/droplets/autoscale/$AUTOSCALE_POOL_ID/history`. + * + * The response body will be a JSON object with a key of `history`. This will be + * set to an array containing objects each representing a history event. + * + */ + get: operations["autoscalepools_list_history"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/v2/firewalls": { parameters: { query?: never; @@ -6755,6 +6951,23 @@ export interface components { */ repo?: string; }; + apps_bitbucket_source_spec: { + /** + * @description The name of the branch to use + * @example main + */ + branch?: string; + /** + * @description Whether to automatically deploy new commits made to the repo + * @example true + */ + deploy_on_push?: boolean; + /** + * @description The name of the repo in the format owner/repo. Example: `digitalocean/sample-golang` + * @example digitalocean/sample-golang + */ + repo?: string; + }; apps_image_source_spec: { /** * @description The registry name. Must be left empty for the `DOCR` registry type. @@ -6913,6 +7126,7 @@ export interface components { git?: components["schemas"]["apps_git_source_spec"]; github?: components["schemas"]["apps_github_source_spec"]; gitlab?: components["schemas"]["apps_gitlab_source_spec"]; + bitbucket?: components["schemas"]["apps_bitbucket_source_spec"]; image?: components["schemas"]["apps_image_source_spec"]; /** * @description The path to the Dockerfile relative to the root of the repo. If set, it will be used to build this component. Otherwise, App Platform will attempt to build it using buildpacks. @@ -7280,6 +7494,7 @@ export interface components { git?: components["schemas"]["apps_git_source_spec"]; github?: components["schemas"]["apps_github_source_spec"]; gitlab?: components["schemas"]["apps_gitlab_source_spec"]; + bitbucket?: components["schemas"]["apps_bitbucket_source_spec"]; /** @description A list of configured log forwarding destinations. */ log_destinations?: components["schemas"]["app_log_destination_definition"][]; }; @@ -7741,6 +7956,19 @@ export interface components { */ id?: string; }; + apps_restart_request: { + /** + * Optional list of components to restart. If not provided, all components will be restarted. + * @example [ + * "component1", + * "component2" + * ] + */ + components?: string[]; + }; + apps_deployment_response: { + deployment?: components["schemas"]["apps_deployment"]; + }; apps_get_logs_response: { /** A list of URLs to archived log files */ historic_urls?: string[]; @@ -7750,6 +7978,13 @@ export interface components { */ live_url?: string; }; + apps_get_exec_response: { + /** + * @description A websocket URL that allows sending/receiving console input and receiving console output. + * @example wss://exec/?token=xxx + */ + url?: string; + }; apps_deployments_response: { /** A list of deployments */ deployments?: components["schemas"]["apps_deployment"][]; @@ -7761,9 +7996,6 @@ export interface components { */ force_build?: boolean; }; - apps_deployment_response: { - deployment?: components["schemas"]["apps_deployment"]; - }; /** * - SHARED: Shared vCPU cores * - DEDICATED: Dedicated vCPU cores @@ -8974,7 +9206,7 @@ export interface components { * @description A unique ID for the database cluster to which the rule is applied. * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 */ - cluster_uuid?: string; + readonly cluster_uuid?: string; /** * @description The type of resource that the firewall rule allows to access the database cluster. * @example droplet @@ -9296,6 +9528,13 @@ export interface components { * @example 4096 */ net_buffer_length?: number; + /** + * @description Defines the destination for logs. Can be `INSIGHTS`, `TABLE`, or both (`INSIGHTS,TABLE`), or `NONE` to disable logs. To specify both destinations, use `INSIGHTS,TABLE` (order matters). Default is NONE. + * @default NONE + * @example INSIGHTS + * @enum {string} + */ + log_output: "INSIGHTS" | "TABLE" | "INSIGHTS,TABLE" | "NONE"; }; /** @description PGBouncer connection pooling settings */ pgbouncer_advanced_config: { @@ -9708,7 +9947,7 @@ export interface components { */ redis_notify_keyspace_events: string; /** - * @description When persistence is 'rdb', Redis does RDB dumps each 10 minutes if any key is changed. Also RDB dumps are done according to backup schedule for backup purposes. When persistence is 'off', no RDB dumps and backups are done, so data can be lost at any moment if service is restarted for any reason, or if service is powered off. Also service can't be forked. + * @description Creates an RDB dump of the database every 10 minutes that can be used to recover data after a node crash. The database does not create the dump if no keys have changed since the last dump. When set to `off`, the database cannot fork services, and data can be lost if a service is restarted or powered off. DigitalOcean Managed Caching databases do not support the Append Only File (AOF) persistence method. * @example rdb * @enum {string} */ @@ -11720,6 +11959,14 @@ export interface components { */ type: "snapshot"; }; + /** + * @description A flat array of tag names as strings to be applied to the resource. Tag names must exist in order to be referenced in a request. + * @example [ + * "base-image", + * "prod" + * ] + */ + existing_tags_array: string[] | null; firewall_rule_base: { /** * @description The type of traffic to be allowed. This may be one of `tcp`, `udp`, or `icmp`. @@ -11763,7 +12010,7 @@ export interface components { * ] */ kubernetes_ids?: string[]; - tags?: components["schemas"]["tags_array"] & unknown; + tags?: components["schemas"]["existing_tags_array"] & unknown; }; firewall_rules: { inbound_rules?: (components["schemas"]["firewall_rule_base"] & { @@ -11821,7 +12068,7 @@ export interface components { * ] */ droplet_ids?: number[] | null; - tags?: components["schemas"]["tags_array"] & unknown; + tags?: components["schemas"]["existing_tags_array"] & unknown; } & components["schemas"]["firewall_rules"]; /** @description An objects containing information about a resource associated with a Droplet. */ associated_resource: { @@ -11927,86 +12174,339 @@ export interface components { */ failures?: number; }; - floating_ip: { + autoscale_pool_static_config: { /** - * Format: ipv4 - * @description The public IP address of the floating IP. It also serves as its identifier. - * @example 45.55.96.47 + * static config + * @description Fixed number of instances in an autoscale pool. + * @example 3 */ - ip?: string; - region?: components["schemas"]["region"] & Record; + target_number_instances: number; + }; + autoscale_pool_dynamic_config: { /** - * @description The Droplet that the floating IP has been assigned to. When you query a floating IP, if it is assigned to a Droplet, the entire Droplet object will be returned. If it is not assigned, the value will be null. - * @example null + * @description The minimum number of Droplets in an autoscale pool. + * @example 5 */ - droplet?: Record | components["schemas"]["droplet"]; + min_instances: number; /** - * @description A boolean value indicating whether or not the floating IP has pending actions preventing new ones from being submitted. - * @example true + * @description The maximum number of Droplets in an autoscale pool. + * @example 10 */ - locked?: boolean; + max_instances: number; /** - * Format: uuid - * @description The UUID of the project to which the reserved IP currently belongs. - * @example 746c6152-2fa2-11ed-92d3-27aaa54e4988 + * Format: float + * @description Target CPU utilization as a decimal. + * @example 0.6 */ - project_id?: string; - }; - floating_ip_create: { + target_cpu_utilization?: number; /** - * @description The ID of the Droplet that the floating IP will be assigned to. - * @example 2457247 + * Format: float + * @description Target memory utilization as a decimal. + * @example 0.6 */ - droplet_id: number; - } | { + target_memory_utilization?: number; /** - * @description The slug identifier for the region the floating IP will be reserved to. - * @example nyc3 + * @description The number of minutes to wait between scaling events in an autoscale pool. Defaults to 10 minutes. + * @example 5 */ - region: string; + cooldown_minutes?: number; + }; + autoscale_pool_droplet_template: { /** - * Format: uuid - * @description The UUID of the project to which the floating IP will be assigned. - * @example 746c6152-2fa2-11ed-92d3-27aaa54e4988 + * @description The name(s) to be applied to all Droplets in the autoscale pool. + * @example my-droplet-name */ - project_id?: string; - }; - floatingIPsAction: { + name?: string; /** - * @description The type of action to initiate for the floating IP. + * @description The datacenter in which all of the Droplets will be created. + * @example tor1 * @enum {string} */ - type: "assign" | "unassign"; - }; - floating_ip_action_assign: Omit & { + region: "nyc1" | "nyc2" | "nyc3" | "ams2" | "ams3" | "sfo1" | "sfo2" | "sfo3" | "sgp1" | "lon1" | "fra1" | "tor1" | "blr1" | "syd1"; /** - * @description The ID of the Droplet that the floating IP will be assigned to. - * @example 758604968 + * @description The Droplet size to be used for all Droplets in the autoscale pool. + * @example c-2 */ - droplet_id: number; - } & { + size: string; /** - * @description discriminator enum property added by openapi-typescript - * @enum {string} + * @description The Droplet image to be used for all Droplets in the autoscale pool. You may specify the slug or the image ID. + * @example ubuntu-20-04-x64 */ - type: "assign"; - }; - floating_ip_action_unassign: Omit & Record & { + image: string; /** - * @description discriminator enum property added by openapi-typescript - * @enum {string} + * @description The SSH keys to be installed on the Droplets in the autoscale pool. You can either specify the key ID or the fingerprint. + * @example [ + * "88:66:90:d2:68:d5:b5:85:e3:26:26:11:31:57:e6:f8" + * ] */ - type: "unassign"; - }; - namespace_info: { + ssh_keys: string[]; /** - * @description The namespace's API hostname. Each function in a namespace is provided an endpoint at the namespace's hostname. - * @example https://api_host.io + * @description The tags to apply to each of the Droplets in the autoscale pool. + * @example [ + * "my-tag" + * ] */ - api_host?: string; + tags?: string[]; /** - * @description A unique string format of UUID with a prefix fn-. - * @example fn-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx + * @description The VPC where the Droplets in the autoscale pool will be created. The VPC must be in the region where you want to create the Droplets. + * @example 760e09ef-dc84-11e8-981e-3cfdfeaae000 + */ + vpc_uuid?: string; + /** + * @description Installs the Droplet agent. This must be set to true to monitor Droplets for resource utilization scaling. + * @example true + */ + with_droplet_agent?: boolean; + /** + * @description The project that the Droplets in the autoscale pool will belong to. + * @example 746c6152-2fa2-11ed-92d3-27aaa54e4988 + */ + project_id?: string; + /** + * @description Assigns a unique IPv6 address to each of the Droplets in the autoscale pool. + * @example true + */ + ipv6?: boolean; + /** + * @description A string containing user data that cloud-init consumes to configure a Droplet on first boot. User data is often a cloud-config file or Bash script. It must be plain text and may not exceed 64 KiB in size. + * @example #cloud-config + * runcmd: + * - touch /test.txt + * + */ + user_data?: string; + }; + current_utilization: { + /** + * Format: float + * @description The average memory utilization of the autoscale pool. + * @example 0.3588531587713522 + */ + memory?: number; + /** + * Format: float + * @description The average CPU utilization of the autoscale pool. + * @example 0.0007338008770232183 + */ + cpu?: number; + }; + autoscale_pool: { + /** + * @description A unique identifier for each autoscale pool instance. This is automatically generated upon autoscale pool creation. + * @example 0d3db13e-a604-4944-9827-7ec2642d32ac + */ + id: string; + /** + * @description The human-readable name set for the autoscale pool. + * @example my-autoscale-pool + */ + name: string; + /** @description The scaling configuration for an autoscale pool, which is how the pool scales up and down (either by resource utilization or static configuration). */ + config: components["schemas"]["autoscale_pool_static_config"] | components["schemas"]["autoscale_pool_dynamic_config"]; + droplet_template: components["schemas"]["autoscale_pool_droplet_template"]; + current_utilization?: components["schemas"]["current_utilization"]; + /** + * The creation time of the autoscale pool + * Format: date-time + * @description A time value given in ISO8601 combined date and time format that represents when the autoscale pool was created. + * @example 2020-07-28T18:00:00Z + */ + created_at: string; + /** + * When the autoscale pool was last updated + * Format: date-time + * @description A time value given in ISO8601 combined date and time format that represents when the autoscale pool was last updated. + * @example 2020-07-28T18:00:00Z + */ + updated_at: string; + /** + * @description The current status of the autoscale pool. + * @example active + * @enum {string} + */ + status: "active" | "deleting" | "error"; + /** + * @description The number of active Droplets in the autoscale pool. + * @example 1 + */ + active_resources_count: number; + }; + autoscale_pool_create: { + /** + * @description The human-readable name of the autoscale pool. This field cannot be updated + * @example my-autoscale-pool + */ + name: string; + /** @description The scaling configuration for an autoscale pool, which is how the pool scales up and down (either by resource utilization or static configuration). */ + config: components["schemas"]["autoscale_pool_static_config"] | components["schemas"]["autoscale_pool_dynamic_config"]; + droplet_template: components["schemas"]["autoscale_pool_droplet_template"]; + }; + member_current_utilization: { + /** + * Format: float + * @description The memory utilization average of the individual Droplet. + * @example 0.3588531587713522 + */ + memory?: number; + /** + * Format: float + * @description The CPU utilization average of the individual Droplet. + * @example 0.0007338008770232183 + */ + cpu?: number; + }; + member: { + /** + * @description The unique identifier of the Droplet. + * @example 459903570 + */ + droplet_id: number; + /** + * Format: date-time + * @description The creation time of the Droplet in ISO8601 combined date and time format. + * @example 2020-07-28T18:00:00Z + */ + created_at: string; + /** + * Format: date-time + * @description The last updated time of the Droplet in ISO8601 combined date and time format. + * @example 2020-07-28T18:00:00Z + */ + updated_at: string; + /** + * @description The health status of the Droplet. + * @example active + */ + health_status: string; + /** + * @description The power status of the Droplet. + * @example active + * @enum {string} + */ + status: "provisioning" | "active" | "deleting" | "off"; + current_utilization: components["schemas"]["member_current_utilization"]; + }; + history: { + /** + * @description The unique identifier of the history event. + * @example 01936530-4471-7b86-9634-32d8fcfecbc6 + */ + history_event_id: string; + /** + * @description The current number of Droplets in the autoscale pool. + * @example 2 + */ + current_instance_count: number; + /** + * @description The target number of Droplets for the autoscale pool after the scaling event. + * @example 2 + */ + desired_instance_count: number; + /** + * @description The reason for the scaling event. + * @example CONFIGURATION_CHANGE + * @enum {string} + */ + reason: "CONFIGURATION_CHANGE" | "SCALE_UP" | "SCALE_DOWN"; + /** + * @description The status of the scaling event. + * @example success + * @enum {string} + */ + status: "in_progress" | "success" | "error"; + /** + * Format: date-time + * @description The creation time of the history event in ISO8601 combined date and time format. + * @example 2020-07-28T18:00:00Z + */ + created_at: string; + /** + * Format: date-time + * @description The last updated time of the history event in ISO8601 combined date and time format. + * @example 2020-07-28T18:00:00Z + */ + updated_at: string; + }; + floating_ip: { + /** + * Format: ipv4 + * @description The public IP address of the floating IP. It also serves as its identifier. + * @example 45.55.96.47 + */ + ip?: string; + region?: components["schemas"]["region"] & Record; + /** + * @description The Droplet that the floating IP has been assigned to. When you query a floating IP, if it is assigned to a Droplet, the entire Droplet object will be returned. If it is not assigned, the value will be null. + * @example null + */ + droplet?: Record | components["schemas"]["droplet"]; + /** + * @description A boolean value indicating whether or not the floating IP has pending actions preventing new ones from being submitted. + * @example true + */ + locked?: boolean; + /** + * Format: uuid + * @description The UUID of the project to which the reserved IP currently belongs. + * @example 746c6152-2fa2-11ed-92d3-27aaa54e4988 + */ + project_id?: string; + }; + floating_ip_create: { + /** + * @description The ID of the Droplet that the floating IP will be assigned to. + * @example 2457247 + */ + droplet_id: number; + } | { + /** + * @description The slug identifier for the region the floating IP will be reserved to. + * @example nyc3 + */ + region: string; + /** + * Format: uuid + * @description The UUID of the project to which the floating IP will be assigned. + * @example 746c6152-2fa2-11ed-92d3-27aaa54e4988 + */ + project_id?: string; + }; + floatingIPsAction: { + /** + * @description The type of action to initiate for the floating IP. + * @enum {string} + */ + type: "assign" | "unassign"; + }; + floating_ip_action_assign: Omit & { + /** + * @description The ID of the Droplet that the floating IP will be assigned to. + * @example 758604968 + */ + droplet_id: number; + } & { + /** + * @description discriminator enum property added by openapi-typescript + * @enum {string} + */ + type: "assign"; + }; + floating_ip_action_unassign: Omit & Record & { + /** + * @description discriminator enum property added by openapi-typescript + * @enum {string} + */ + type: "unassign"; + }; + namespace_info: { + /** + * @description The namespace's API hostname. Each function in a namespace is provided an endpoint at the namespace's hostname. + * @example https://api_host.io + */ + api_host?: string; + /** + * @description A unique string format of UUID with a prefix fn-. + * @example fn-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx */ namespace?: string; /** @@ -13011,6 +13511,13 @@ export interface components { * @enum {string} */ network: "EXTERNAL" | "INTERNAL"; + /** + * @description A string indicating whether the load balancer should be a standard regional HTTP load balancer, a regional network load balancer that routes traffic at the TCP/UDP transport layer, or a global load balancer. + * @default REGIONAL + * @example REGIONAL + * @enum {string} + */ + type: "REGIONAL" | "REGIONAL_NETWORK" | "GLOBAL"; }; load_balancer: components["schemas"]["load_balancer_base"] & { region?: unknown & components["schemas"]["region"]; @@ -14652,6 +15159,18 @@ export interface components { "application/json": components["schemas"]["apps_delete_app_response"]; }; }; + /** @description A JSON object with a `deployment` key. */ + new_app_deployment: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["apps_deployment_response"]; + }; + }; /** @description A JSON object with urls that point to archived logs */ list_logs: { headers: { @@ -14664,8 +15183,8 @@ export interface components { "application/json": components["schemas"]["apps_get_logs_response"]; }; }; - /** @description A JSON object with a `deployments` key. This will be a list of all app deployments */ - existing_deployments: { + /** @description A JSON object with a websocket URL that allows sending/receiving console input and output. */ + get_exec: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -14673,11 +15192,11 @@ export interface components { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["apps_deployments_response"]; + "application/json": components["schemas"]["apps_get_exec_response"]; }; }; - /** @description A JSON object with a `deployment` key. */ - new_app_deployment: { + /** @description A JSON object with a `deployments` key. This will be a list of all app deployments */ + existing_deployments: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -14685,7 +15204,7 @@ export interface components { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["apps_deployment_response"]; + "application/json": components["schemas"]["apps_deployments_response"]; }; }; /** @description A JSON of the requested deployment */ @@ -15694,8 +16213,8 @@ export interface components { "application/json": components["schemas"]["error"]; }; }; - /** @description To list all of the firewalls available on your account, send a GET request to `/v2/firewalls`. */ - list_firewalls_response: { + /** @description A JSON object with a key of `autoscale_pools`. */ + all_autoscale_pools: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -15704,12 +16223,12 @@ export interface components { }; content: { "application/json": { - firewalls?: components["schemas"]["firewall"][]; + autoscale_pools?: components["schemas"]["autoscale_pool"][]; } & components["schemas"]["pagination"] & components["schemas"]["meta"]; }; }; - /** @description The response will be a JSON object with a firewall key. This will be set to an object containing the standard firewall attributes */ - create_firewall_response: { + /** @description Accepted */ + autoscale_pool_create: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -15718,12 +16237,14 @@ export interface components { }; content: { "application/json": { - firewall?: components["schemas"]["firewall"]; + autoscale_pool?: components["schemas"]["autoscale_pool"]; }; }; }; - /** @description Bad Request */ - bad_request: { + /** @description The response will be a JSON object with a key called `autoscale_pool`. This will be + * set to a JSON object that contains the standard autoscale pool attributes. + * */ + existing_autoscale_pool: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -15731,11 +16252,13 @@ export interface components { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["error"]; + "application/json": { + autoscale_pool?: components["schemas"]["autoscale_pool"]; + }; }; }; - /** @description The response will be a JSON object with a firewall key. This will be set to an object containing the standard firewall attributes. */ - get_firewall_response: { + /** @description A JSON object with a key of `droplets`. */ + all_members: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -15744,12 +16267,12 @@ export interface components { }; content: { "application/json": { - firewall?: components["schemas"]["firewall"]; - }; + droplets?: components["schemas"]["member"][]; + } & components["schemas"]["pagination"] & components["schemas"]["meta"]; }; }; - /** @description The response will be a JSON object with a `firewall` key. This will be set to an object containing the standard firewall attributes. */ - put_firewall_response: { + /** @description A JSON object with a key of `history`. */ + history_events: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -15758,12 +16281,12 @@ export interface components { }; content: { "application/json": { - firewall?: components["schemas"]["firewall"]; - }; + history?: components["schemas"]["history"][]; + } & components["schemas"]["pagination"] & components["schemas"]["meta"]; }; }; - /** @description The response will be a JSON object with a key called `floating_ips`. This will be set to an array of floating IP objects, each of which will contain the standard floating IP attributes */ - floating_ip_list: { + /** @description To list all of the firewalls available on your account, send a GET request to `/v2/firewalls`. */ + list_firewalls_response: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -15772,13 +16295,12 @@ export interface components { }; content: { "application/json": { - floating_ips?: components["schemas"]["floating_ip"][]; + firewalls?: components["schemas"]["firewall"][]; } & components["schemas"]["pagination"] & components["schemas"]["meta"]; }; }; - /** @description The response will be a JSON object with a key called `floating_ip`. The value of this will be an object that contains the standard attributes associated with a floating IP. - * When assigning a floating IP to a Droplet at same time as it created, the response's `links` object will contain links to both the Droplet and the assignment action. The latter can be used to check the status of the action. */ - floating_ip_created: { + /** @description The response will be a JSON object with a firewall key. This will be set to an object containing the standard firewall attributes */ + create_firewall_response: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -15787,17 +16309,86 @@ export interface components { }; content: { "application/json": { - floating_ip?: components["schemas"]["floating_ip"]; - links?: { - droplets?: components["schemas"]["action_link"][]; - actions?: components["schemas"]["action_link"][]; - }; + firewall?: components["schemas"]["firewall"]; }; }; }; - /** @description The response will be a JSON object with a key called `floating_ip`. The value of this will be an object that contains the standard attributes associated with a floating IP. */ - floating_ip: { - headers: { + /** @description Bad Request */ + bad_request: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + /** @description The response will be a JSON object with a firewall key. This will be set to an object containing the standard firewall attributes. */ + get_firewall_response: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": { + firewall?: components["schemas"]["firewall"]; + }; + }; + }; + /** @description The response will be a JSON object with a `firewall` key. This will be set to an object containing the standard firewall attributes. */ + put_firewall_response: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": { + firewall?: components["schemas"]["firewall"]; + }; + }; + }; + /** @description The response will be a JSON object with a key called `floating_ips`. This will be set to an array of floating IP objects, each of which will contain the standard floating IP attributes */ + floating_ip_list: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": { + floating_ips?: components["schemas"]["floating_ip"][]; + } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + }; + }; + /** @description The response will be a JSON object with a key called `floating_ip`. The value of this will be an object that contains the standard attributes associated with a floating IP. + * When assigning a floating IP to a Droplet at same time as it created, the response's `links` object will contain links to both the Droplet and the assignment action. The latter can be used to check the status of the action. */ + floating_ip_created: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": { + floating_ip?: components["schemas"]["floating_ip"]; + links?: { + droplets?: components["schemas"]["action_link"][]; + actions?: components["schemas"]["action_link"][]; + }; + }; + }; + }; + /** @description The response will be a JSON object with a key called `floating_ip`. The value of this will be an object that contains the standard attributes associated with a floating IP. */ + floating_ip: { + headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; "ratelimit-reset": components["headers"]["ratelimit-reset"]; @@ -17484,6 +18075,21 @@ export interface components { * @example true */ x_dangerous: boolean; + /** + * @description The name of the autoscale pool + * @example my-autoscale-pool + */ + autoscale_pool_name: string; + /** + * @description A unique identifier for an autoscale pool. + * @example 0d3db13e-a604-4944-9827-7ec2642d32ac + */ + autoscale_pool_id: string; + /** + * @description Acknowledge this action will destroy the autoscale pool and its associated resources and _can not_ be reversed. + * @example true + */ + parameters_x_dangerous: boolean; /** * @description A unique ID that can be used to identify and reference a firewall. * @example bb4b2611-3d72-467b-8602-280330ecd65c @@ -18178,6 +18784,33 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; + apps_restart: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description The app ID + * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf + */ + app_id: components["parameters"]["app_id"]; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": components["schemas"]["apps_restart_request"]; + }; + }; + responses: { + 200: components["responses"]["new_app_deployment"]; + 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; apps_get_logs_active_deployment: { parameters: { query: { @@ -18226,6 +18859,34 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; + apps_get_exec_active_deployment: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description The app ID + * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf + */ + app_id: components["parameters"]["app_id"]; + /** + * @description An optional component name. If set, logs will be limited to this component only. + * @example component + */ + component_name: components["parameters"]["component"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["get_exec"]; + 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; apps_list_deployments: { parameters: { query?: { @@ -18444,6 +19105,39 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; + apps_get_exec: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description The app ID + * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf + */ + app_id: components["parameters"]["app_id"]; + /** + * @description The deployment ID + * @example 3aa4d20e-5527-4c00-b496-601fbd22520a + */ + deployment_id: components["parameters"]["deployment_id"]; + /** + * @description An optional component name. If set, logs will be limited to this component only. + * @example component + */ + component_name: components["parameters"]["component"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["get_exec"]; + 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; apps_get_logs_active_deployment_aggregate: { parameters: { query: { @@ -21759,6 +22453,228 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; + autoscalepools_list: { + parameters: { + query?: { + /** + * @description Number of items returned per page + * @example 2 + */ + per_page?: components["parameters"]["per_page"]; + /** + * @description Which 'page' of paginated results to return. + * @example 1 + */ + page?: components["parameters"]["page"]; + /** + * @description The name of the autoscale pool + * @example my-autoscale-pool + */ + name?: components["parameters"]["autoscale_pool_name"]; + }; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["all_autoscale_pools"]; + 401: components["responses"]["unauthorized"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + autoscalepools_create: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": components["schemas"]["autoscale_pool_create"]; + }; + }; + responses: { + 202: components["responses"]["autoscale_pool_create"]; + 401: components["responses"]["unauthorized"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + autoscalepools_get: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for an autoscale pool. + * @example 0d3db13e-a604-4944-9827-7ec2642d32ac + */ + autoscale_pool_id: components["parameters"]["autoscale_pool_id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["existing_autoscale_pool"]; + 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + autoscalepools_update: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for an autoscale pool. + * @example 0d3db13e-a604-4944-9827-7ec2642d32ac + */ + autoscale_pool_id: components["parameters"]["autoscale_pool_id"]; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": components["schemas"]["autoscale_pool_create"]; + }; + }; + responses: { + 200: components["responses"]["autoscale_pool_create"]; + 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + autoscalepools_delete: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for an autoscale pool. + * @example 0d3db13e-a604-4944-9827-7ec2642d32ac + */ + autoscale_pool_id: components["parameters"]["autoscale_pool_id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 202: components["responses"]["no_content"]; + 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + autoscalepools_delete_dangerous: { + parameters: { + query?: never; + header: { + /** + * @description Acknowledge this action will destroy the autoscale pool and its associated resources and _can not_ be reversed. + * @example true + */ + "X-Dangerous": components["parameters"]["parameters_x_dangerous"]; + }; + path: { + /** + * @description A unique identifier for an autoscale pool. + * @example 0d3db13e-a604-4944-9827-7ec2642d32ac + */ + autoscale_pool_id: components["parameters"]["autoscale_pool_id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 202: components["responses"]["no_content"]; + 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + autoscalepools_list_members: { + parameters: { + query?: { + /** + * @description Number of items returned per page + * @example 2 + */ + per_page?: components["parameters"]["per_page"]; + /** + * @description Which 'page' of paginated results to return. + * @example 1 + */ + page?: components["parameters"]["page"]; + }; + header?: never; + path: { + /** + * @description A unique identifier for an autoscale pool. + * @example 0d3db13e-a604-4944-9827-7ec2642d32ac + */ + autoscale_pool_id: components["parameters"]["autoscale_pool_id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["all_members"]; + 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + autoscalepools_list_history: { + parameters: { + query?: { + /** + * @description Number of items returned per page + * @example 2 + */ + per_page?: components["parameters"]["per_page"]; + /** + * @description Which 'page' of paginated results to return. + * @example 1 + */ + page?: components["parameters"]["page"]; + }; + header?: never; + path: { + /** + * @description A unique identifier for an autoscale pool. + * @example 0d3db13e-a604-4944-9827-7ec2642d32ac + */ + autoscale_pool_id: components["parameters"]["autoscale_pool_id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["history_events"]; + 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; firewalls_list: { parameters: { query?: { @@ -22069,7 +22985,7 @@ export interface operations { * ] * } */ "application/json": { - tags: components["schemas"]["tags_array"] & unknown; + tags: components["schemas"]["existing_tags_array"] & unknown; }; }; }; @@ -22104,7 +23020,7 @@ export interface operations { * ] * } */ "application/json": { - tags: components["schemas"]["tags_array"] & unknown; + tags: components["schemas"]["existing_tags_array"] & unknown; }; }; }; diff --git a/packages/openapi-typescript/examples/digital-ocean-api/DigitalOcean-public.v2.yaml b/packages/openapi-typescript/examples/digital-ocean-api/DigitalOcean-public.v2.yaml index ff8df2f42..d29ec984c 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/DigitalOcean-public.v2.yaml +++ b/packages/openapi-typescript/examples/digital-ocean-api/DigitalOcean-public.v2.yaml @@ -228,6 +228,10 @@ tags: types. Find more information about each of these objects in their respective sections. + - name: Droplet Autoscale Pools + description: |- + Droplet autoscale pools manage automatic horizontal scaling for your applications based on resource usage (CPU, memory, or both) or a static configuration. + - name: Firewalls description: |- [DigitalOcean Cloud Firewalls](https://docs.digitalocean.com/products/networking/firewalls/) @@ -549,10 +553,18 @@ paths: put: $ref: 'resources/apps/apps_update.yml' + /v2/apps/{app_id}/restart: + post: + $ref: 'resources/apps/apps_restart.yml' + /v2/apps/{app_id}/components/{component_name}/logs: get: $ref: 'resources/apps/apps_get_logs_active_deployment.yml' + /v2/apps/{app_id}/components/{component_name}/exec: + get: + $ref: 'resources/apps/apps_get_exec_active_deployment.yml' + /v2/apps/{app_id}/deployments: get: $ref: 'resources/apps/apps_list_deployments.yml' @@ -575,6 +587,10 @@ paths: get: $ref: 'resources/apps/apps_get_logs_aggregate.yml' + /v2/apps/{app_id}/deployments/{deployment_id}/components/{component_name}/exec: + get: + $ref: 'resources/apps/apps_get_exec.yml' + /v2/apps/{app_id}/logs: get: $ref: 'resources/apps/apps_get_logs_active_deployment_aggregate.yml' @@ -986,6 +1002,32 @@ paths: post: $ref: 'resources/droplets/droplets_destroy_retryWithAssociatedResources.yml' + /v2/droplets/autoscale: + get: + $ref: 'resources/autoscale_pools/autoscale_pool_list.yml' + post: + $ref: 'resources/autoscale_pools/autoscale_pool_create.yml' + + /v2/droplets/autoscale/{autoscale_pool_id}: + get: + $ref: 'resources/autoscale_pools/autoscale_pool_get.yml' + put: + $ref: 'resources/autoscale_pools/autoscale_pool_update.yml' + delete: + $ref: 'resources/autoscale_pools/autoscale_pool_delete.yml' + + /v2/droplets/autoscale/{autoscale_pool_id}/dangerous: + delete: + $ref: 'resources/autoscale_pools/autoscale_pool_delete_dangerous.yml' + + /v2/droplets/autoscale/{autoscale_pool_id}/members: + get: + $ref: 'resources/autoscale_pools/autoscale_pool_list_members.yml' + + /v2/droplets/autoscale/{autoscale_pool_id}/history: + get: + $ref: 'resources/autoscale_pools/autoscale_pool_list_history.yml' + /v2/firewalls: get: $ref: 'resources/firewalls/firewalls_list.yml' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_exec.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_exec.yml new file mode 100755 index 000000000..5baea4905 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_exec.yml @@ -0,0 +1,42 @@ +operationId: apps_get_exec + +summary: Retrieve Exec URL for Deployment + +description: + Returns a websocket URL that allows sending/receiving console input and output + to a component of the specified deployment if one exists. + +tags: + - Apps + +parameters: + - $ref: parameters.yml#/app_id + - $ref: parameters.yml#/deployment_id + - $ref: parameters.yml#/component + +responses: + "200": + $ref: responses/get_exec.yml + + "401": + $ref: ../../shared/responses/unauthorized.yml + + "404": + $ref: "../../shared/responses/not_found.yml" + + "429": + $ref: "../../shared/responses/too_many_requests.yml" + + "500": + $ref: ../../shared/responses/server_error.yml + + default: + $ref: ../../shared/responses/unexpected_error.yml + +x-codeSamples: + - $ref: "examples/curl/apps_get_exec.yml" + - $ref: "examples/python/apps_get_exec.yml" + +security: + - bearer_auth: + - "app:update" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_exec_active_deployment.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_exec_active_deployment.yml new file mode 100755 index 000000000..0bba438f2 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_exec_active_deployment.yml @@ -0,0 +1,41 @@ +operationId: apps_get_exec_active_deployment + +summary: Retrieve Exec URL + +description: + Returns a websocket URL that allows sending/receiving console input and output + to a component of the active deployment if one exists. + +tags: + - Apps + +parameters: + - $ref: parameters.yml#/app_id + - $ref: parameters.yml#/component + +responses: + "200": + $ref: responses/get_exec.yml + + "401": + $ref: ../../shared/responses/unauthorized.yml + + "404": + $ref: "../../shared/responses/not_found.yml" + + "429": + $ref: "../../shared/responses/too_many_requests.yml" + + "500": + $ref: ../../shared/responses/server_error.yml + + default: + $ref: ../../shared/responses/unexpected_error.yml + +x-codeSamples: + - $ref: "examples/curl/apps_get_exec_active_deployment.yml" + - $ref: "examples/python/apps_get_exec_active_deployment.yml" + +security: + - bearer_auth: + - "app:update" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_restart.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_restart.yml new file mode 100755 index 000000000..c59adb204 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_restart.yml @@ -0,0 +1,44 @@ +operationId: apps_restart + +summary: Restart an App + +description: Perform a rolling restart of all or specific components in an app. + +tags: + - Apps + +parameters: + - $ref: parameters.yml#/app_id + +requestBody: + content: + application/json: + schema: + $ref: models/apps_restart_request.yml + +responses: + "200": + $ref: responses/new_app_deployment.yml + + "401": + $ref: ../../shared/responses/unauthorized.yml + + "404": + $ref: "../../shared/responses/not_found.yml" + + "429": + $ref: "../../shared/responses/too_many_requests.yml" + + "500": + $ref: ../../shared/responses/server_error.yml + + default: + $ref: ../../shared/responses/unexpected_error.yml + +x-codeSamples: + - $ref: "examples/curl/apps_restart.yml" + - $ref: "examples/python/apps_restart.yml" + +security: + - bearer_auth: + - "app:update" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/examples/curl/apps_get_exec.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/examples/curl/apps_get_exec.yml new file mode 100644 index 000000000..9a0b859a0 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/examples/curl/apps_get_exec.yml @@ -0,0 +1,6 @@ +lang: cURL +source: |- + curl -X GET \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/apps/{app_id}/deployments/{deployment_id}/components/{component_name}/exec" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/examples/curl/apps_get_exec_active_deployment.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/examples/curl/apps_get_exec_active_deployment.yml new file mode 100644 index 000000000..5794ef9e9 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/examples/curl/apps_get_exec_active_deployment.yml @@ -0,0 +1,6 @@ +lang: cURL +source: |- + curl -X GET \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/apps/{app_id}/components/{component_name}/exec" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/examples/curl/apps_restart.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/examples/curl/apps_restart.yml new file mode 100644 index 000000000..467323f0f --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/examples/curl/apps_restart.yml @@ -0,0 +1,6 @@ +lang: cURL +source: |- + curl -X POST \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/apps/{app_id}/restart" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/examples/curl/apps_update.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/examples/curl/apps_update.yml index 4956fb91e..1757d84ac 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/examples/curl/apps_update.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/examples/curl/apps_update.yml @@ -1,6 +1,7 @@ lang: cURL source: |- curl -X PUT \ - -H "Content-Type: application/json" \ - -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ - "https://api.digitalocean.com/v2/apps/{id}" + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/apps/{id}" \ + -d '{"alerts":[{"rule":"DEPLOYMENT_FAILED"},{"rule":"DOMAIN_FAILED"}],"domains":[{"domain":"example.com","type":"PRIMARY","zone":"example.com"}],"envs":[{"key":"API_KEY","scope":"RUN_AND_BUILD_TIME","type":"SECRET","value":"EV[1:zqiRIeaaYK/NqctZDYzy6t0pTrtRDez8:wqGpZRrsKN5nPhWQrS479cfBiXT0WQ==]"}],"features":["buildpack-stack=ubuntu-22"],"ingress":{},"name":"example-app","region":"nyc","services":[{"autoscaling":{"max_instance_count":4,"metrics":{"cpu":{"percent":70}},"min_instance_count":2},"git":{"branch":"main","repo_clone_url":"https://github.com/digitalocean/sample-nodejs.git"},"internal_ports":[8080],"log_destinations":[{"name":"your_log_consumer_name","open_search":{"endpoint":"logs.example.com:12345","basic_auth":{"user":"doadmin","password":"1234567890abcdef"},"index_name":"example-index","cluster_name":"example-cluster"}}],"name":"sample-nodejs","run_command":"yarn start","source_dir":"/"}]}' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/examples/python/apps_get_exec.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/examples/python/apps_get_exec.yml new file mode 100644 index 000000000..ad292fd1f --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/examples/python/apps_get_exec.yml @@ -0,0 +1,8 @@ +lang: Python +source: |- + import os + from pydo import Client + + client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN")) + + get_resp = client.apps.get_exec(app_id="4f6c71e2", deployment_id="3aa4d20e", component_name="component") diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/examples/python/apps_get_exec_active_deployment.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/examples/python/apps_get_exec_active_deployment.yml new file mode 100644 index 000000000..fb53ef449 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/examples/python/apps_get_exec_active_deployment.yml @@ -0,0 +1,8 @@ +lang: Python +source: |- + import os + from pydo import Client + + client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN")) + + get_resp = client.apps.get_exec_active_deployment(app_id="a6adf840", component_name="component") diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/examples/python/apps_restart.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/examples/python/apps_restart.yml new file mode 100644 index 000000000..6c979bcaf --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/examples/python/apps_restart.yml @@ -0,0 +1,8 @@ +lang: Python +source: |- + import os + from pydo import Client + + client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN")) + + create_resp = client.apps.restart(app_id="b6bdf840", body={"components": ["component1", "component2"]}) diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_component_base.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_component_base.yml index 99230a789..fffe0fac8 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_component_base.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_component_base.yml @@ -18,6 +18,9 @@ properties: gitlab: $ref: apps_gitlab_source_spec.yml + bitbucket: + $ref: apps_bitbucket_source_spec.yml + image: $ref: apps_image_source_spec.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_functions_spec.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_functions_spec.yml index fbb61695c..0f11795c8 100755 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_functions_spec.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_functions_spec.yml @@ -49,6 +49,9 @@ properties: gitlab: $ref: apps_gitlab_source_spec.yml + bitbucket: + $ref: apps_bitbucket_source_spec.yml + log_destinations: type: array items: diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/apps_bitbucket_source_spec.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/apps_bitbucket_source_spec.yml new file mode 100644 index 000000000..89ff8cbfb --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/apps_bitbucket_source_spec.yml @@ -0,0 +1,16 @@ +type: object +properties: + branch: + type: string + description: The name of the branch to use + example: main + + deploy_on_push: + type: boolean + description: Whether to automatically deploy new commits made to the repo + example: true + + repo: + type: string + description: 'The name of the repo in the format owner/repo. Example: `digitalocean/sample-golang`' + example: digitalocean/sample-golang diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/apps_get_exec_response.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/apps_get_exec_response.yml new file mode 100755 index 000000000..fa730fa94 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/apps_get_exec_response.yml @@ -0,0 +1,6 @@ +properties: + url: + description: A websocket URL that allows sending/receiving console input and receiving console output. + type: string + example: wss://exec/?token=xxx +type: object diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/apps_restart_request.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/apps_restart_request.yml new file mode 100755 index 000000000..915e2b7a4 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/apps_restart_request.yml @@ -0,0 +1,10 @@ +type: object +properties: + components: + title: Optional list of components to restart. If not provided, all components will be restarted. + type: array + items: + type: string + example: + - component1 + - component2 diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/responses/examples.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/responses/examples.yml index 94fdccfa7..a5994aeca 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/responses/examples.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/responses/examples.yml @@ -599,6 +599,10 @@ logs: historic_logs: - https://logs-example/archive/build.log +exec: + value: + url: wss://exec/?token=xxx + regions: value: regions: diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/responses/get_exec.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/responses/get_exec.yml new file mode 100644 index 000000000..435813b0a --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/responses/get_exec.yml @@ -0,0 +1,17 @@ +description: A JSON object with a websocket URL that allows sending/receiving console input and output. + +content: + application/json: + schema: + $ref: ../models/apps_get_exec_response.yml + examples: + exec: + $ref: examples.yml#/exec + +headers: + ratelimit-limit: + $ref: ../../../shared/headers.yml#/ratelimit-limit + ratelimit-remaining: + $ref: ../../../shared/headers.yml#/ratelimit-remaining + ratelimit-reset: + $ref: ../../../shared/headers.yml#/ratelimit-reset diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/autoscale_pool_create.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/autoscale_pool_create.yml new file mode 100644 index 000000000..2d039d1d1 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/autoscale_pool_create.yml @@ -0,0 +1,45 @@ +operationId: autoscalepools_create + +summary: Create a New Autoscale Pool + +description: | + To create a new autoscale pool, send a POST request to `/v2/droplets/autoscale` setting the required attributes. + + The response body will contain a JSON object with a key called `autoscale_pool` containing the standard attributes for the new autoscale pool. + +tags: + - Droplet Autoscale Pools + +requestBody: + content: + application/json: + schema: + $ref: 'models/autoscale_pool_create.yml' + examples: + Autoscale Create Request Dynamic Config: + $ref: 'examples.yml#/autoscale_create_request_dynamic' + Autoscale Create Request Static Config: + $ref: 'examples.yml#/autoscale_create_request_static' + +responses: + '202': + $ref: 'responses/autoscale_pool_create.yml' + + '401': + $ref: '../../shared/responses/unauthorized.yml' + + '429': + $ref: '../../shared/responses/too_many_requests.yml' + + '500': + $ref: '../../shared/responses/server_error.yml' + + default: + $ref: '../../shared/responses/unexpected_error.yml' + +x-codeSamples: + - $ref: 'examples/curl/autoscale_pool_create.yml' + +security: + - bearer_auth: + - 'droplet:create' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/autoscale_pool_delete.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/autoscale_pool_delete.yml new file mode 100644 index 000000000..74cd40ecb --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/autoscale_pool_delete.yml @@ -0,0 +1,40 @@ +operationId: autoscalepools_delete + +summary: Delete autoscale pool + +description: | + To destroy an autoscale pool, send a DELETE request to the `/v2/droplets/autoscale/$AUTOSCALE_POOL_ID` endpoint. + + A successful response will include a 202 response code and no content. + +tags: + - Droplet Autoscale Pools + +parameters: + - $ref: 'parameters.yml#/autoscale_pool_id' + +responses: + '202': + $ref: '../../shared/responses/no_content.yml' + + '401': + $ref: '../../shared/responses/unauthorized.yml' + + '404': + $ref: '../../shared/responses/not_found.yml' + + '429': + $ref: '../../shared/responses/too_many_requests.yml' + + '500': + $ref: '../../shared/responses/server_error.yml' + + default: + $ref: '../../shared/responses/unexpected_error.yml' + +x-codeSamples: + - $ref: 'examples/curl/autoscale_pool_delete.yml' + +security: + - bearer_auth: + - 'droplet:delete' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/autoscale_pool_delete_dangerous.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/autoscale_pool_delete_dangerous.yml new file mode 100644 index 000000000..6309ab7f4 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/autoscale_pool_delete_dangerous.yml @@ -0,0 +1,40 @@ +operationId: autoscalepools_delete_dangerous + +summary: Delete autoscale pool and resources + +description: | + To destroy an autoscale pool and its associated resources (Droplets), + send a DELETE request to the `/v2/droplets/autoscale/$AUTOSCALE_POOL_ID/dangerous` endpoint. + +tags: + - Droplet Autoscale Pools + +parameters: + - $ref: 'parameters.yml#/autoscale_pool_id' + - $ref: 'parameters.yml#/x_dangerous' + +responses: + '202': + $ref: '../../shared/responses/no_content.yml' + + '401': + $ref: '../../shared/responses/unauthorized.yml' + + '404': + $ref: '../../shared/responses/not_found.yml' + + '429': + $ref: '../../shared/responses/too_many_requests.yml' + + '500': + $ref: '../../shared/responses/server_error.yml' + + default: + $ref: '../../shared/responses/unexpected_error.yml' + +x-codeSamples: + - $ref: 'examples/curl/autoscale_pool_delete_dangerous.yml' + +security: + - bearer_auth: + - 'droplet:delete' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/autoscale_pool_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/autoscale_pool_get.yml new file mode 100644 index 000000000..cc8127267 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/autoscale_pool_get.yml @@ -0,0 +1,39 @@ +operationId: autoscalepools_get + +summary: Retrieve an Existing Autoscale Pool + +description: | + To show information about an individual autoscale pool, send a GET request to + `/v2/droplets/autoscale/$AUTOSCALE_POOL_ID`. + +tags: + - Droplet Autoscale Pools + +parameters: + - $ref: 'parameters.yml#/autoscale_pool_id' + +responses: + '200': + $ref: 'responses/existing_autoscale_pool.yml' + + '401': + $ref: '../../shared/responses/unauthorized.yml' + + '404': + $ref: '../../shared/responses/not_found.yml' + + '429': + $ref: '../../shared/responses/too_many_requests.yml' + + '500': + $ref: '../../shared/responses/server_error.yml' + + default: + $ref: '../../shared/responses/unexpected_error.yml' + +x-codeSamples: + - $ref: 'examples/curl/autoscale_pool_get.yml' + +security: + - bearer_auth: + - 'droplet:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/autoscale_pool_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/autoscale_pool_list.yml new file mode 100644 index 000000000..3a40dc5ee --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/autoscale_pool_list.yml @@ -0,0 +1,40 @@ +operationId: autoscalepools_list + +summary: List All Autoscale Pools + +description: | + To list all autoscale pools in your team, send a GET request to `/v2/droplets/autoscale`. + The response body will be a JSON object with a key of `autoscale_pools` containing an array of autoscale pool objects. + These each contain the standard autoscale pool attributes. + +tags: + - Droplet Autoscale Pools + +parameters: + - $ref: '../../shared/parameters.yml#/per_page' + - $ref: '../../shared/parameters.yml#/page' + - $ref: './parameters.yml#/autoscale_pool_name' + +responses: + '200': + $ref: 'responses/all_autoscale_pools.yml' + + '401': + $ref: '../../shared/responses/unauthorized.yml' + + '429': + $ref: '../../shared/responses/too_many_requests.yml' + + '500': + $ref: '../../shared/responses/server_error.yml' + + default: + $ref: '../../shared/responses/unexpected_error.yml' + +x-codeSamples: + - $ref: 'examples/curl/autoscale_pools_list.yml' + + +security: + - bearer_auth: + - 'droplet:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/autoscale_pool_list_history.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/autoscale_pool_list_history.yml new file mode 100644 index 000000000..426706c3f --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/autoscale_pool_list_history.yml @@ -0,0 +1,44 @@ +operationId: autoscalepools_list_history + +summary: List history events + +description: | + To list all of the scaling history events of an autoscale pool, send a GET request to `/v2/droplets/autoscale/$AUTOSCALE_POOL_ID/history`. + + The response body will be a JSON object with a key of `history`. This will be + set to an array containing objects each representing a history event. + +tags: + - Droplet Autoscale Pools + +parameters: + - $ref: '../../shared/parameters.yml#/per_page' + - $ref: '../../shared/parameters.yml#/page' + - $ref: 'parameters.yml#/autoscale_pool_id' + +responses: + '200': + $ref: 'responses/history_events.yml' + + '401': + $ref: '../../shared/responses/unauthorized.yml' + + '404': + $ref: '../../shared/responses/not_found.yml' + + '429': + $ref: '../../shared/responses/too_many_requests.yml' + + '500': + $ref: '../../shared/responses/server_error.yml' + + default: + $ref: '../../shared/responses/unexpected_error.yml' + +x-codeSamples: + - $ref: 'examples/curl/autoscale_pool_history_events.yml' + + +security: + - bearer_auth: + - 'droplet:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/autoscale_pool_list_members.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/autoscale_pool_list_members.yml new file mode 100644 index 000000000..7b8ee23f7 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/autoscale_pool_list_members.yml @@ -0,0 +1,44 @@ +operationId: autoscalepools_list_members + +summary: List members + +description: | + To list the Droplets in an autoscale pool, send a GET request to `/v2/droplets/autoscale/$AUTOSCALE_POOL_ID/members`. + + The response body will be a JSON object with a key of `droplets`. This will be + set to an array containing information about each of the Droplets in the autoscale pool. + +tags: + - Droplet Autoscale Pools + +parameters: + - $ref: '../../shared/parameters.yml#/per_page' + - $ref: '../../shared/parameters.yml#/page' + - $ref: 'parameters.yml#/autoscale_pool_id' + +responses: + '200': + $ref: 'responses/all_members.yml' + + '401': + $ref: '../../shared/responses/unauthorized.yml' + + '404': + $ref: '../../shared/responses/not_found.yml' + + '429': + $ref: '../../shared/responses/too_many_requests.yml' + + '500': + $ref: '../../shared/responses/server_error.yml' + + default: + $ref: '../../shared/responses/unexpected_error.yml' + +x-codeSamples: + - $ref: 'examples/curl/autoscale_pool_members.yml' + + +security: + - bearer_auth: + - 'droplet:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/autoscale_pool_update.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/autoscale_pool_update.yml new file mode 100644 index 000000000..46278e1da --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/autoscale_pool_update.yml @@ -0,0 +1,49 @@ +operationId: autoscalepools_update + +summary: Update Autoscale Pool + +description: | + To update the configuration of an existing autoscale pool, send a PUT request to + `/v2/droplets/autoscale/$AUTOSCALE_POOL_ID`. The request must contain a full representation + of the autoscale pool including existing attributes. + +tags: + - Droplet Autoscale Pools + +parameters: + - $ref: 'parameters.yml#/autoscale_pool_id' + +requestBody: + content: + application/json: + schema: + $ref: 'models/autoscale_pool_create.yml' + examples: + Autoscale Update Request: + $ref: 'examples.yml#/autoscale_update_request' + +responses: + '200': + $ref: 'responses/autoscale_pool_create.yml' + + '401': + $ref: '../../shared/responses/unauthorized.yml' + + '404': + $ref: '../../shared/responses/not_found.yml' + + '429': + $ref: '../../shared/responses/too_many_requests.yml' + + '500': + $ref: '../../shared/responses/server_error.yml' + + default: + $ref: '../../shared/responses/unexpected_error.yml' + +x-codeSamples: + - $ref: 'examples/curl/autoscale_pool_update.yml' + +security: + - bearer_auth: + - 'droplet:create' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/examples.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/examples.yml new file mode 100644 index 000000000..5cd7ebe45 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/examples.yml @@ -0,0 +1,63 @@ +autoscale_create_request_dynamic: + value: + name: "my-autoscale-pool" + config: + min_instances: 1 + max_instances: 5 + target_cpu_utilization: 0.5 + cooldown_minutes: 10 + droplet_template: + name: example.com + region: nyc3 + size: c-2 + image: ubuntu-20-04-x64 + ssh_keys: + - 3b:16:e4:bf:8b:00:8b:b8:59:8c:a9:d3:f0:19:fa:45 + backups: true + ipv6: true + monitoring: true + tags: + - env:prod + - web + user_data: "#cloud-config\nruncmd:\n - touch /test.txt\n" + vpc_uuid: 760e09ef-dc84-11e8-981e-3cfdfeaae000 +autoscale_create_request_static: + value: + name: "my-autoscale-pool" + config: + target_number_instances: 2 + droplet_template: + name: example.com + region: nyc3 + size: c-2 + image: ubuntu-20-04-x64 + ssh_keys: + - 3b:16:e4:bf:8b:00:8b:b8:59:8c:a9:d3:f0:19:fa:45 + backups: true + ipv6: true + monitoring: true + tags: + - env:prod + - web + user_data: "#cloud-config\nruncmd:\n - touch /test.txt\n" + vpc_uuid: 760e09ef-dc84-11e8-981e-3cfdfeaae000 +autoscale_update_request: + value: + name: "my-autoscale-pool" + config: + target_number_instances: 2 + droplet_template: + name: example.com + region: nyc3 + size: c-2 + image: ubuntu-20-04-x64 + ssh_keys: + - 3b:16:e4:bf:8b:00:8b:b8:59:8c:a9:d3:f0:19:fa:45 + backups: true + ipv6: true + monitoring: true + tags: + - env:prod + - web + user_data: "#cloud-config\nruncmd:\n - touch /test.txt\n" + vpc_uuid: 760e09ef-dc84-11e8-981e-3cfdfeaae000 diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/examples/curl/autoscale_pool_create.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/examples/curl/autoscale_pool_create.yml new file mode 100644 index 000000000..8a6e9403d --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/examples/curl/autoscale_pool_create.yml @@ -0,0 +1,30 @@ +lang: cURL +source: |- + curl -X POST \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + -d '{ + "name": "test-autoscalergroup", + "config": { + "min_instances": 1, + "max_instances": 5, + "target_cpu_utilization": 0.5, + "cooldown_minutes": 5 + }, + "droplet_template": { + "size": "c-2", + "region": "tor1", + "image": "ubuntu-20-04-x64", + "tags": [ + "test-ag-01" + ], + "ssh_keys": [ + "392594", + "385255" + ], + "vpc_uuid": "c472520a-831e-4770-8135-542c57a69daa", + "ipv6": true, + "user_data": "\n#cloud-config\nruncmd:\n- apt-get update\n" + } + }' \ + "https://api.digitalocean.com/v2/droplets/autoscale" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/examples/curl/autoscale_pool_delete.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/examples/curl/autoscale_pool_delete.yml new file mode 100644 index 000000000..9db345797 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/examples/curl/autoscale_pool_delete.yml @@ -0,0 +1,6 @@ +lang: cURL +source: |- + curl -X DELETE \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/droplets/autoscale/880fee37-d07a-4f94-94a0-f07d9fc7bbb4" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/examples/curl/autoscale_pool_delete_dangerous.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/examples/curl/autoscale_pool_delete_dangerous.yml new file mode 100644 index 000000000..db76f5b73 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/examples/curl/autoscale_pool_delete_dangerous.yml @@ -0,0 +1,7 @@ +lang: cURL +source: |- + curl -X DELETE \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + -H "X-Dangerous: true" \ + "https://api.digitalocean.com/v2/droplets/autoscale/880fee37-d07a-4f94-94a0-f07d9fc7bbb4/dangerous" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/examples/curl/autoscale_pool_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/examples/curl/autoscale_pool_get.yml new file mode 100644 index 000000000..219256d78 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/examples/curl/autoscale_pool_get.yml @@ -0,0 +1,6 @@ +lang: cURL +source: |- + curl -X GET \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/droplets/autoscale/880fee37-d07a-4f94-94a0-f07d9fc7bbb4" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/examples/curl/autoscale_pool_history_events.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/examples/curl/autoscale_pool_history_events.yml new file mode 100644 index 000000000..f4ddb63ad --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/examples/curl/autoscale_pool_history_events.yml @@ -0,0 +1,6 @@ +lang: cURL +source: |- + curl -X GET \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/droplets/autoscale/07445b1b-1dc1-414d-b0a7-239ac66a9148/history" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/examples/curl/autoscale_pool_members.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/examples/curl/autoscale_pool_members.yml new file mode 100644 index 000000000..72ab0a9aa --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/examples/curl/autoscale_pool_members.yml @@ -0,0 +1,6 @@ +lang: cURL +source: |- + curl -X GET \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/droplets/autoscale/d0067f19-c9bd-4d8c-b28b-e464fd1fb250/members" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/examples/curl/autoscale_pool_update.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/examples/curl/autoscale_pool_update.yml new file mode 100644 index 000000000..a36f222ec --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/examples/curl/autoscale_pool_update.yml @@ -0,0 +1,32 @@ +lang: cURL +source: |- + curl -X PUT \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + -d '{ + "name": "test-autoscalergroup-01", + "config": { + "min_instances": 1, + "max_instances": 5, + "target_cpu_utilization": 0.5, + "cooldown_minutes": 10 + }, + "droplet_template": { + "size": "c-2", + "region": "tor1", + "image": "ubuntu-20-04-x64", + "tags": [ + "test-ag-01" + ], + "ssh_keys": [ + "372862", + "367582", + "355790" + ], + "vpc_uuid": "4637280e-3842-4661-a628-a6f0392959d3", + "with_droplet_agent": true, + "ipv6": true, + "user_data": "\n#cloud-config\nruncmd:\n- apt-get update\n" + } + }' \ + "https://api.digitalocean.com/v2/droplets/autoscale/d0067f19-c9bd-4d8c-b28b-e464fd1fb250" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/examples/curl/autoscale_pools_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/examples/curl/autoscale_pools_list.yml new file mode 100644 index 000000000..137d297c7 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/examples/curl/autoscale_pools_list.yml @@ -0,0 +1,6 @@ +lang: cURL +source: |- + curl -X GET \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/droplets/autoscale?page=1&per_page=1" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/models/autoscale_pool.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/models/autoscale_pool.yml new file mode 100644 index 000000000..2c567d749 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/models/autoscale_pool.yml @@ -0,0 +1,68 @@ +type: object + +properties: + id: + type: string + example: 0d3db13e-a604-4944-9827-7ec2642d32ac + description: A unique identifier for each autoscale pool instance. This is + automatically generated upon autoscale pool creation. + + name: + type: string + example: my-autoscale-pool + description: The human-readable name set for the autoscale pool. + + config: + oneOf: + - $ref: ../models/autoscale_pool_static_config.yml + - $ref: ../models/autoscale_pool_dynamic_config.yml + type: object + description: The scaling configuration for an autoscale pool, which + is how the pool scales up and down (either by resource utilization + or static configuration). + + droplet_template: + $ref: ../models/autoscale_pool_droplet_template.yml + + current_utilization: + $ref: ../models/current_utilization.yml + + created_at: + format: date-time + title: The creation time of the autoscale pool + type: string + example: 2020-07-28T18:00:00Z + description: A time value given in ISO8601 combined date and time format + that represents when the autoscale pool was created. + + updated_at: + format: date-time + title: When the autoscale pool was last updated + type: string + example: 2020-07-28T18:00:00Z + description: A time value given in ISO8601 combined date and time format + that represents when the autoscale pool was last updated. + + status: + type: string + enum: + - active + - deleting + - error + description: The current status of the autoscale pool. + example: active + + active_resources_count: + type: integer + example: 1 + description: The number of active Droplets in the autoscale pool. + +required: + - id + - name + - config + - droplet_template + - created_at + - updated_at + - status + - active_resources_count diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/models/autoscale_pool_create.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/models/autoscale_pool_create.yml new file mode 100644 index 000000000..fd1e8e5ec --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/models/autoscale_pool_create.yml @@ -0,0 +1,22 @@ +type: object + +properties: + name: + example: "my-autoscale-pool" + type: string + description: "The human-readable name of the autoscale pool. This field cannot be updated" + config: + oneOf: + - $ref: ../models/autoscale_pool_static_config.yml + - $ref: ../models/autoscale_pool_dynamic_config.yml + type: object + description: The scaling configuration for an autoscale pool, which + is how the pool scales up and down (either by resource utilization + or static configuration). + droplet_template: + $ref: ../models/autoscale_pool_droplet_template.yml + +required: + - name + - config + - droplet_template diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/models/autoscale_pool_droplet_template.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/models/autoscale_pool_droplet_template.yml new file mode 100644 index 000000000..990d132b7 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/models/autoscale_pool_droplet_template.yml @@ -0,0 +1,89 @@ +type: object + +properties: + name: + type: string + example: my-droplet-name + description: "The name(s) to be applied to all Droplets in the autoscale pool." + + region: + type: string + example: tor1 + enum: + - nyc1 + - nyc2 + - nyc3 + - ams2 + - ams3 + - sfo1 + - sfo2 + - sfo3 + - sgp1 + - lon1 + - fra1 + - tor1 + - blr1 + - syd1 + description: The datacenter in which all of the Droplets will be created. + + size: + type: string + example: c-2 + description: The Droplet size to be used for all Droplets in the autoscale pool. + + image: + type: string + example: ubuntu-20-04-x64 + description: The Droplet image to be used for all Droplets in the autoscale pool. + You may specify the slug or the image ID. + + ssh_keys: + type: array + items: + type: string + example: + - "88:66:90:d2:68:d5:b5:85:e3:26:26:11:31:57:e6:f8" + description: The SSH keys to be installed on the Droplets in the autoscale pool. You can either specify the key ID or the fingerprint. + + tags: + type: array + items: + type: string + example: + - my-tag + description: The tags to apply to each of the Droplets in the autoscale pool. + + vpc_uuid: + type: string + description: The VPC where the Droplets in the autoscale pool will be created. The VPC must be in the region where you want to create the Droplets. + example: 760e09ef-dc84-11e8-981e-3cfdfeaae000 + + with_droplet_agent: + type: boolean + description: Installs the Droplet agent. This must be set to true to monitor Droplets for resource utilization scaling. + example: true + + project_id: + type: string + description: The project that the Droplets in the autoscale pool will belong to. + example: 746c6152-2fa2-11ed-92d3-27aaa54e4988 + + ipv6: + type: boolean + description: Assigns a unique IPv6 address to each of the Droplets in the autoscale pool. + example: true + + user_data: + type: string + example: | + #cloud-config + runcmd: + - touch /test.txt + description: A string containing user data that cloud-init consumes to configure a Droplet on first boot. + User data is often a cloud-config file or Bash script. It must be plain text and may not exceed 64 KiB in size. + +required: + - region + - image + - size + - ssh_keys diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/models/autoscale_pool_dynamic_config.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/models/autoscale_pool_dynamic_config.yml new file mode 100644 index 000000000..2cf9b4fc9 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/models/autoscale_pool_dynamic_config.yml @@ -0,0 +1,39 @@ +type: object + +properties: + min_instances: + type: integer + example: 5 + description: The minimum number of Droplets in an autoscale pool. + minimum: 1 + maximum: 500 + max_instances: + type: integer + example: 10 + description: The maximum number of Droplets in an autoscale pool. + minimum: 1 + maximum: 1000 + target_cpu_utilization: + type: number + format: float + example: 0.6 + description: Target CPU utilization as a decimal. + minimum: 0.05 + maximum: 1 + target_memory_utilization: + type: number + format: float + example: 0.6 + description: Target memory utilization as a decimal. + minimum: 0.05 + maximum: 1 + cooldown_minutes: + type: integer + example: 5 + description: The number of minutes to wait between scaling events in an autoscale pool. Defaults to 10 minutes. + minimum: 5 + maximum: 20 + +required: + - min_instances + - max_instances diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/models/autoscale_pool_static_config.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/models/autoscale_pool_static_config.yml new file mode 100644 index 000000000..415fb5fa4 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/models/autoscale_pool_static_config.yml @@ -0,0 +1,13 @@ +type: object + +properties: + target_number_instances: + title: static config + type: integer + example: 3 + description: Fixed number of instances in an autoscale pool. + minimum: 1 + maximum: 1000 + +required: + - target_number_instances diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/models/current_utilization.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/models/current_utilization.yml new file mode 100644 index 000000000..47e0536b1 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/models/current_utilization.yml @@ -0,0 +1,17 @@ +type: object + +properties: + memory: + type: number + format: float + example: 0.3588531587713522 + description: The average memory utilization of the autoscale pool. + minimum: 0 + maximum: 1 + cpu: + type: number + format: float + example: 0.0007338008770232183 + description: The average CPU utilization of the autoscale pool. + minimum: 0 + maximum: 1 diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/models/history.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/models/history.yml new file mode 100644 index 000000000..1ffd3147d --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/models/history.yml @@ -0,0 +1,50 @@ +type: object + +properties: + history_event_id: + type: string + example: 01936530-4471-7b86-9634-32d8fcfecbc6 + description: The unique identifier of the history event. + current_instance_count: + type: integer + example: 2 + description: The current number of Droplets in the autoscale pool. + desired_instance_count: + type: integer + example: 2 + description: The target number of Droplets for the autoscale pool after the scaling event. + reason: + type: string + enum: + - CONFIGURATION_CHANGE + - SCALE_UP + - SCALE_DOWN + description: The reason for the scaling event. + example: 'CONFIGURATION_CHANGE' + status: + type: string + enum: + - in_progress + - success + - error + description: The status of the scaling event. + example: 'success' + created_at: + format: date-time + description: The creation time of the history event in ISO8601 combined date and time format. + type: string + example: 2020-07-28T18:00:00Z + updated_at: + format: date-time + description: The last updated time of the history event in ISO8601 combined date and time format. + type: string + example: 2020-07-28T18:00:00Z + +required: + - history_event_id + - current_instance_count + - desired_instance_count + - reason + - status + - created_at + - updated_at diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/models/member.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/models/member.yml new file mode 100644 index 000000000..43a024e16 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/models/member.yml @@ -0,0 +1,40 @@ +type: object + +properties: + droplet_id: + type: integer + example: 459903570 + description: The unique identifier of the Droplet. + created_at: + format: date-time + description: The creation time of the Droplet in ISO8601 combined date and time format. + type: string + example: 2020-07-28T18:00:00Z + updated_at: + format: date-time + description: The last updated time of the Droplet in ISO8601 combined date and time format. + type: string + example: 2020-07-28T18:00:00Z + health_status: + type: string + example: 'active' + description: The health status of the Droplet. + status: + type: string + enum: + - provisioning + - active + - deleting + - "off" + description: The power status of the Droplet. + example: "active" + current_utilization: + $ref: ../models/member_current_utilization.yml + +required: + - droplet_id + - created_at + - updated_at + - health_status + - status + - current_utilization diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/models/member_current_utilization.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/models/member_current_utilization.yml new file mode 100644 index 000000000..1dabe39e8 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/models/member_current_utilization.yml @@ -0,0 +1,13 @@ +type: object + +properties: + memory: + type: number + format: float + example: 0.3588531587713522 + description: The memory utilization average of the individual Droplet. + cpu: + type: number + format: float + example: 0.0007338008770232183 + description: The CPU utilization average of the individual Droplet. diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/parameters.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/parameters.yml new file mode 100644 index 000000000..503781ca4 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/parameters.yml @@ -0,0 +1,24 @@ +autoscale_pool_id: + in: path + name: autoscale_pool_id + description: A unique identifier for an autoscale pool. + required: true + schema: + type: string + example: 0d3db13e-a604-4944-9827-7ec2642d32ac +x_dangerous: + in: header + name: X-Dangerous + description: Acknowledge this action will destroy the autoscale pool and its + associated resources and _can not_ be reversed. + schema: + type: boolean + example: true + required: true +autoscale_pool_name: + name: name + in: query + description: The name of the autoscale pool + schema: + type: string + example: my-autoscale-pool diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/responses/all_autoscale_pools.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/responses/all_autoscale_pools.yml new file mode 100644 index 000000000..704f1c830 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/responses/all_autoscale_pools.yml @@ -0,0 +1,26 @@ +description: A JSON object with a key of `autoscale_pools`. + +headers: + ratelimit-limit: + $ref: '../../../shared/headers.yml#/ratelimit-limit' + ratelimit-remaining: + $ref: '../../../shared/headers.yml#/ratelimit-remaining' + ratelimit-reset: + $ref: '../../../shared/headers.yml#/ratelimit-reset' + + +content: + application/json: + schema: + allOf: + - type: object + properties: + autoscale_pools: + type: array + items: + $ref: '../models/autoscale_pool.yml' + - $ref: '../../../shared/pages.yml#/pagination' + - $ref: '../../../shared/meta.yml' + examples: + All Autoscale Pools: + $ref: 'examples.yml#/autoscale_pools_all' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/responses/all_members.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/responses/all_members.yml new file mode 100644 index 000000000..6d5dac881 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/responses/all_members.yml @@ -0,0 +1,27 @@ +description: A JSON object with a key of `droplets`. + +headers: + ratelimit-limit: + $ref: '../../../shared/headers.yml#/ratelimit-limit' + ratelimit-remaining: + $ref: '../../../shared/headers.yml#/ratelimit-remaining' + ratelimit-reset: + $ref: '../../../shared/headers.yml#/ratelimit-reset' + + +content: + application/json: + schema: + allOf: + - type: object + properties: + droplets: + type: array + items: + $ref: '../models/member.yml' + - $ref: '../../../shared/pages.yml#/pagination' + - $ref: '../../../shared/meta.yml' + examples: + All members: + $ref: 'examples.yml#/members_all' + diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/responses/autoscale_pool_create.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/responses/autoscale_pool_create.yml new file mode 100644 index 000000000..f3b0b4baf --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/responses/autoscale_pool_create.yml @@ -0,0 +1,22 @@ +description: Accepted + +headers: + ratelimit-limit: + $ref: '../../../shared/headers.yml#/ratelimit-limit' + ratelimit-remaining: + $ref: '../../../shared/headers.yml#/ratelimit-remaining' + ratelimit-reset: + $ref: '../../../shared/headers.yml#/ratelimit-reset' + +content: + application/json: + schema: + properties: + autoscale_pool: + $ref: '../models/autoscale_pool.yml' + + examples: + Autoscale Create Response Dynamic Config: + $ref: 'examples.yml#/autoscale_create_response_dynamic' + Autoscale Create Response Static Config: + $ref: 'examples.yml#/autoscale_create_response_static' \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/responses/examples.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/responses/examples.yml new file mode 100644 index 000000000..ff8274474 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/responses/examples.yml @@ -0,0 +1,148 @@ +autoscale_pools_all: + value: + autoscale_pools: + - id: 0d3db13e-a604-4944-9827-7ec2642d32ac + name: "test-autoscaler-group-01" + config: + min_instances: 1 + max_instances: 5 + target_cpu_utilization: 0.5 + cooldown_minutes: 10 + droplet_template: + name: "droplet-name" + size: c-2 + region: tor1 + image: ubuntu-20-04-x64 + tags: + - my-tag + ssh_keys: + - 3b:16:e4:bf:8b:00:8b:b8:59:8c:a9:d3:f0:19:fa:45 + vpc_uuid: 760e09ef-dc84-11e8-981e-3cfdfeaae000 + with_droplet_agent: true + project_id: 746c6152-2fa2-11ed-92d3-27aaa54e4988 + ipv6: true + user_data: "#cloud-config\nruncmd:\n - touch /test.txt\n" + created_at: 2020-11-19T20:27:18Z + updated_at: 2020-12-01T00:42:16Z + current_utilization: + memory: 0.3588531587713522 + cpu: 0.0007338008770232183 + status: active + active_resources_count: 1 + links: + pages: + meta: + total: 1 +autoscale_pool_single: + value: + autoscale_pool: + id: 0d3db13e-a604-4944-9827-7ec2642d32ac + name: "test-autoscaler-group-01" + config: + min_instances: 1 + max_instances: 5 + target_cpu_utilization: 0.5 + cooldown_minutes: 10 + droplet_template: + name: "droplet-name" + size: c-2 + region: tor1 + image: 'ubuntu-20-04-x64' + tags: + - my-tag + ssh_keys: + - 3b:16:e4:bf:8b:00:8b:b8:59:8c:a9:d3:f0:19:fa:45 + vpc_uuid: 760e09ef-dc84-11e8-981e-3cfdfeaae000 + with_droplet_agent: true + project_id: 746c6152-2fa2-11ed-92d3-27aaa54e4988 + ipv6: true + user_data: "#cloud-config\nruncmd:\n - touch /test.txt\n" + created_at: 2020-11-19T20:27:18Z + updated_at: 2020-12-01T00:42:16Z + current_utilization: + memory: 0.3588531587713522 + cpu: 0.0007338008770232183 + status: active + active_resources_count: 1 +members_all: + value: + droplets: + - droplet_id: 123456 + created_at: 2020-11-19T20:27:18Z + updated_at: 2020-12-01T00:42:16Z + health_status: "healthy" + status: "active" + current_utilization: + memory: 0.3588531587713522 + cpu: 0.0007338008770232183 + links: + pages: + meta: + total: 1 +history_all: + value: + history: + - history_event_id: 01936530-4471-7b86-9634-32d8fcfecbc6 + current_instance_count: 2 + desired_instance_count: 2 + reason: "CONFIGURATION_CHANGE" + status: "success" + created_at: 2020-11-19T20:27:18Z + updated_at: 2020-12-01T00:42:16Z + links: + pages: + meta: + total: 1 +autoscale_create_response_dynamic: + value: + autoscale_pool: + id: 0d3db13e-a604-4944-9827-7ec2642d32ac + name: "test-autoscaler-group-01" + config: + min_instances: 1 + max_instances: 5 + target_cpu_utilization: 0.5 + cooldown_minutes: 10 + droplet_template: + name: "droplet-name" + size: c-2 + region: tor1 + image: 'ubuntu-20-04-x64' + tags: + - my-tag + ssh_keys: + - 3b:16:e4:bf:8b:00:8b:b8:59:8c:a9:d3:f0:19:fa:45 + vpc_uuid: 760e09ef-dc84-11e8-981e-3cfdfeaae000 + with_droplet_agent: true + project_id: 746c6152-2fa2-11ed-92d3-27aaa54e4988 + ipv6: true + user_data: "#cloud-config\nruncmd:\n - touch /test.txt\n" + created_at: 2020-11-19T20:27:18Z + updated_at: 2020-12-01T00:42:16Z + status: active + active_resources_count: 1 +autoscale_create_response_static: + value: + autoscale_pool: + id: 0d3db13e-a604-4944-9827-7ec2642d32ac + name: "test-autoscaler-group-01" + config: + target_number_instances: 1 + droplet_template: + name: "droplet-name" + size: c-2 + region: tor1 + image: 'ubuntu-20-04-x64' + tags: + - my-tag + ssh_keys: + - 3b:16:e4:bf:8b:00:8b:b8:59:8c:a9:d3:f0:19:fa:45 + vpc_uuid: 760e09ef-dc84-11e8-981e-3cfdfeaae000 + with_droplet_agent: true + project_id: 746c6152-2fa2-11ed-92d3-27aaa54e4988 + ipv6: true + user_data: "#cloud-config\nruncmd:\n - touch /test.txt\n" + created_at: 2020-11-19T20:27:18Z + updated_at: 2020-12-01T00:42:16Z + status: active + active_resources_count: 1 diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/responses/existing_autoscale_pool.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/responses/existing_autoscale_pool.yml new file mode 100644 index 000000000..6643b13cc --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/responses/existing_autoscale_pool.yml @@ -0,0 +1,21 @@ +description: | + The response will be a JSON object with a key called `autoscale_pool`. This will be + set to a JSON object that contains the standard autoscale pool attributes. + +headers: + ratelimit-limit: + $ref: '../../../shared/headers.yml#/ratelimit-limit' + ratelimit-remaining: + $ref: '../../../shared/headers.yml#/ratelimit-remaining' + ratelimit-reset: + $ref: '../../../shared/headers.yml#/ratelimit-reset' + +content: + application/json: + schema: + properties: + autoscale_pool: + $ref: '../models/autoscale_pool.yml' + examples: + Single Autoscale Pool: + $ref: 'examples.yml#/autoscale_pool_single' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/responses/history_events.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/responses/history_events.yml new file mode 100644 index 000000000..49f974444 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/responses/history_events.yml @@ -0,0 +1,25 @@ +description: A JSON object with a key of `history`. + +headers: + ratelimit-limit: + $ref: '../../../shared/headers.yml#/ratelimit-limit' + ratelimit-remaining: + $ref: '../../../shared/headers.yml#/ratelimit-remaining' + ratelimit-reset: + $ref: '../../../shared/headers.yml#/ratelimit-reset' + +content: + application/json: + schema: + allOf: + - type: object + properties: + history: + type: array + items: + $ref: '../models/history.yml' + - $ref: '../../../shared/pages.yml#/pagination' + - $ref: '../../../shared/meta.yml' + examples: + All History Events: + $ref: 'examples.yml#/history_all' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/advanced_config/mysql_advanced_config.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/advanced_config/mysql_advanced_config.yml index 5b3c776f6..bd74a352b 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/advanced_config/mysql_advanced_config.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/advanced_config/mysql_advanced_config.yml @@ -254,3 +254,14 @@ properties: minimum: 1024 maximum: 1048576 example: 4096 + log_output: + description: >- + Defines the destination for logs. Can be `INSIGHTS`, `TABLE`, or both (`INSIGHTS,TABLE`), or `NONE` to disable logs. To specify both destinations, use `INSIGHTS,TABLE` (order matters). Default is NONE. + type: string + enum: + - INSIGHTS + - TABLE + - INSIGHTS,TABLE + - NONE + example: INSIGHTS + default: NONE diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/advanced_config/redis_advanced_config.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/advanced_config/redis_advanced_config.yml index ed24a02c3..a733d286d 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/advanced_config/redis_advanced_config.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/advanced_config/redis_advanced_config.yml @@ -86,11 +86,12 @@ properties: - "off" - rdb description: >- - When persistence is 'rdb', Redis does RDB dumps each 10 minutes if any key - is changed. Also RDB dumps are done according to backup schedule for - backup purposes. When persistence is 'off', no RDB dumps and backups are - done, so data can be lost at any moment if service is restarted for any - reason, or if service is powered off. Also service can't be forked. + Creates an RDB dump of the database every 10 minutes that can be used + to recover data after a node crash. The database does not create the + dump if no keys have changed since the last dump. When set to `off`, + the database cannot fork services, and data can be lost if a service + is restarted or powered off. DigitalOcean Managed Caching databases + do not support the Append Only File (AOF) persistence method. example: rdb redis_acl_channels_default: type: string diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/firewall_rule.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/firewall_rule.yml index 6fbcb43df..d93e723d9 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/firewall_rule.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/firewall_rule.yml @@ -10,6 +10,7 @@ properties: type: string pattern: '^$|[0-9a-f]{8}\b-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-\b[0-9a-f]{12}' example: 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + readOnly: true description: A unique ID for the database cluster to which the rule is applied. type: type: string diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_get_backup_policy.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_get_backup_policy.yml index 2cff6149a..1a9497251 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_get_backup_policy.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_get_backup_policy.yml @@ -10,30 +10,32 @@ tags: - Droplets parameters: - - $ref: 'parameters.yml#/droplet_id' + - $ref: "parameters.yml#/droplet_id" responses: - '200': - $ref: 'responses/droplet_backup_policy.yml' + "200": + $ref: "responses/droplet_backup_policy.yml" - '401': - $ref: '../../shared/responses/unauthorized.yml' + "401": + $ref: "../../shared/responses/unauthorized.yml" - '404': - $ref: '../../shared/responses/not_found.yml' + "404": + $ref: "../../shared/responses/not_found.yml" - '429': - $ref: '../../shared/responses/too_many_requests.yml' + "429": + $ref: "../../shared/responses/too_many_requests.yml" - '500': - $ref: '../../shared/responses/server_error.yml' + "500": + $ref: "../../shared/responses/server_error.yml" default: - $ref: '../../shared/responses/unexpected_error.yml' + $ref: "../../shared/responses/unexpected_error.yml" x-codeSamples: - - $ref: 'examples/curl/droplets_get_backup_policy.yml' + - $ref: "examples/curl/droplets_get_backup_policy.yml" + - $ref: "examples/go/droplets_get_backup_policy.yml" + - $ref: "examples/python/droplets_get_backup_policy.yml" security: - bearer_auth: - - 'droplet:read' + - "droplet:read" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_list_backup_policies.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_list_backup_policies.yml index c0f013635..3d9f8fe18 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_list_backup_policies.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_list_backup_policies.yml @@ -10,31 +10,33 @@ tags: - Droplets parameters: - - $ref: '../../shared/parameters.yml#/per_page' - - $ref: '../../shared/parameters.yml#/page' + - $ref: "../../shared/parameters.yml#/per_page" + - $ref: "../../shared/parameters.yml#/page" responses: - '200': - $ref: 'responses/all_droplet_backup_policies.yml' + "200": + $ref: "responses/all_droplet_backup_policies.yml" - '401': - $ref: '../../shared/responses/unauthorized.yml' + "401": + $ref: "../../shared/responses/unauthorized.yml" - '404': - $ref: '../../shared/responses/not_found.yml' + "404": + $ref: "../../shared/responses/not_found.yml" - '429': - $ref: '../../shared/responses/too_many_requests.yml' + "429": + $ref: "../../shared/responses/too_many_requests.yml" - '500': - $ref: '../../shared/responses/server_error.yml' + "500": + $ref: "../../shared/responses/server_error.yml" default: - $ref: '../../shared/responses/unexpected_error.yml' + $ref: "../../shared/responses/unexpected_error.yml" x-codeSamples: - - $ref: 'examples/curl/droplets_list_backup_policies.yml' + - $ref: "examples/curl/droplets_list_backup_policies.yml" + - $ref: "examples/go/droplets_list_backup_policies.yml" + - $ref: "examples/python/droplets_list_backup_policies.yml" security: - bearer_auth: - - 'droplet:read' + - "droplet:read" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_list_supported_backup_policies.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_list_supported_backup_policies.yml index f6974eaf4..e7cc8d106 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_list_supported_backup_policies.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_list_supported_backup_policies.yml @@ -10,27 +10,29 @@ tags: - Droplets responses: - '200': - $ref: 'responses/droplets_supported_backup_policies.yml' + "200": + $ref: "responses/droplets_supported_backup_policies.yml" - '401': - $ref: '../../shared/responses/unauthorized.yml' + "401": + $ref: "../../shared/responses/unauthorized.yml" - '404': - $ref: '../../shared/responses/not_found.yml' + "404": + $ref: "../../shared/responses/not_found.yml" - '429': - $ref: '../../shared/responses/too_many_requests.yml' + "429": + $ref: "../../shared/responses/too_many_requests.yml" - '500': - $ref: '../../shared/responses/server_error.yml' + "500": + $ref: "../../shared/responses/server_error.yml" default: - $ref: '../../shared/responses/unexpected_error.yml' + $ref: "../../shared/responses/unexpected_error.yml" x-codeSamples: - - $ref: 'examples/curl/droplets_list_supported_backup_policies.yml' + - $ref: "examples/curl/droplets_list_supported_backup_policies.yml" + - $ref: "examples/go/droplets_list_supported_backup_policies.yml" + - $ref: "examples/python/droplets_list_supported_backup_policies.yml" security: - bearer_auth: - - 'droplet:read' + - "droplet:read" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/examples/go/droplets_get_backup_policy.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/examples/go/droplets_get_backup_policy.yml new file mode 100644 index 000000000..a9cf8fb73 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/examples/go/droplets_get_backup_policy.yml @@ -0,0 +1,17 @@ +lang: Go +source: |- + import ( + "context" + "os" + + "github.com/digitalocean/godo" + ) + + func main() { + token := os.Getenv("DIGITALOCEAN_TOKEN") + + client := godo.NewFromToken(token) + ctx := context.TODO() + + droplet, _, err := client.Droplets.GetBackupPolicy(ctx, 444909706) + } diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/examples/go/droplets_list_backup_policies.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/examples/go/droplets_list_backup_policies.yml new file mode 100644 index 000000000..55b642087 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/examples/go/droplets_list_backup_policies.yml @@ -0,0 +1,17 @@ +lang: Go +source: |- + import ( + "context" + "os" + + "github.com/digitalocean/godo" + ) + + func main() { + token := os.Getenv("DIGITALOCEAN_TOKEN") + + client := godo.NewFromToken(token) + ctx := context.TODO() + + droplet, _, err := client.Droplets.ListBackupPolicies(ctx) + } diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/examples/go/droplets_list_supported_backup_policies.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/examples/go/droplets_list_supported_backup_policies.yml new file mode 100644 index 000000000..6ab5913a8 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/examples/go/droplets_list_supported_backup_policies.yml @@ -0,0 +1,17 @@ +lang: Go +source: |- + import ( + "context" + "os" + + "github.com/digitalocean/godo" + ) + + func main() { + token := os.Getenv("DIGITALOCEAN_TOKEN") + + client := godo.NewFromToken(token) + ctx := context.TODO() + + droplet, _, err := client.Droplets.ListSupportedBackupPolicies(ctx) + } diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/examples/python/droplets_get_backup_policy.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/examples/python/droplets_get_backup_policy.yml new file mode 100644 index 000000000..00e1bdb01 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/examples/python/droplets_get_backup_policy.yml @@ -0,0 +1,8 @@ +lang: Python +source: |- + import os + from pydo import Client + + client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN")) + + resp = client.droplets.get_backup_policy(droplet_id=444909706) diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/examples/python/droplets_list_backup_policies.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/examples/python/droplets_list_backup_policies.yml new file mode 100644 index 000000000..1dd0e4c63 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/examples/python/droplets_list_backup_policies.yml @@ -0,0 +1,8 @@ +lang: Python +source: |- + import os + from pydo import Client + + client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN")) + + resp = client.droplets.list_backup_policies() diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/examples/python/droplets_list_supported_backup_policies.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/examples/python/droplets_list_supported_backup_policies.yml new file mode 100644 index 000000000..eb6e0bbd7 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/examples/python/droplets_list_supported_backup_policies.yml @@ -0,0 +1,8 @@ +lang: Python +source: |- + import os + from pydo import Client + + client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN")) + + resp = client.droplets.list_supported_backup_policies() diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/responses/droplets_supported_backup_policies.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/responses/droplets_supported_backup_policies.yml index 6ae6be4b7..385f7e5e7 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/responses/droplets_supported_backup_policies.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/responses/droplets_supported_backup_policies.yml @@ -1,14 +1,13 @@ description: A JSON object with an `supported_policies` key set to an array of objects describing each supported backup policy. - headers: ratelimit-limit: - $ref: '../../../shared/headers.yml#/ratelimit-limit' + $ref: "../../../shared/headers.yml#/ratelimit-limit" ratelimit-remaining: - $ref: '../../../shared/headers.yml#/ratelimit-remaining' + $ref: "../../../shared/headers.yml#/ratelimit-remaining" ratelimit-reset: - $ref: '../../../shared/headers.yml#/ratelimit-reset' + $ref: "../../../shared/headers.yml#/ratelimit-reset" content: application/json: @@ -18,36 +17,36 @@ content: supported_policies: type: array items: - $ref: '../models/supported_droplet_backup_policy.yml' + $ref: "../models/supported_droplet_backup_policy.yml" example: supported_policies: - - name: "weekly" - possible_window_starts: - - 0 - - 4 - - 8 - - 12 - - 16 - - 20 - window_length_hours: 4 - retention_period_days: 28 - possible_days": - - "SUN" - - "MON" - - "TUE" - - "WED" - - "THU" - - "FRI" - - "SAT" - - name: "daily" - possible_window_starts: - - 0 - - 4 - - 8 - - 12 - - 16 - - 20 - window_length_hours: 4 - retention_period_days: 7 - possible_days: [] + - name: "weekly" + possible_window_starts: + - 0 + - 4 + - 8 + - 12 + - 16 + - 20 + window_length_hours: 4 + retention_period_days: 28 + possible_days: + - "SUN" + - "MON" + - "TUE" + - "WED" + - "THU" + - "FRI" + - "SAT" + - name: "daily" + possible_window_starts: + - 0 + - 4 + - 8 + - 12 + - 16 + - 20 + window_length_hours: 4 + retention_period_days: 7 + possible_days: [] diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_add_tags.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_add_tags.yml index 6fec85907..c1e8e5f6b 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_add_tags.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_add_tags.yml @@ -15,7 +15,7 @@ tags: - Firewalls parameters: - - $ref: 'parameters.yml#/firewall_id' + - $ref: "parameters.yml#/firewall_id" requestBody: content: @@ -24,7 +24,7 @@ requestBody: properties: tags: allOf: - - $ref: '../../shared/attributes/tags_array.yml' + - $ref: "../../shared/attributes/existing_tags_array.yml" - description: >- An array containing the names of the Tags to be assigned to the firewall. @@ -37,33 +37,33 @@ requestBody: - frontend responses: - '204': - $ref: '../../shared/responses/no_content.yml' + "204": + $ref: "../../shared/responses/no_content.yml" - '400': - $ref: '../../shared/responses/bad_request.yml' + "400": + $ref: "../../shared/responses/bad_request.yml" - '401': - $ref: '../../shared/responses/unauthorized.yml' + "401": + $ref: "../../shared/responses/unauthorized.yml" - '404': - $ref: '../../shared/responses/not_found.yml' + "404": + $ref: "../../shared/responses/not_found.yml" - '429': - $ref: '../../shared/responses/too_many_requests.yml' + "429": + $ref: "../../shared/responses/too_many_requests.yml" - '500': - $ref: '../../shared/responses/server_error.yml' + "500": + $ref: "../../shared/responses/server_error.yml" default: - $ref: '../../shared/responses/unexpected_error.yml' + $ref: "../../shared/responses/unexpected_error.yml" x-codeSamples: - - $ref: 'examples/curl/firewalls_add_tags.yml' - - $ref: 'examples/go/firewalls_add_tags.yml' - - $ref: 'examples/ruby/firewalls_add_tags.yml' - - $ref: 'examples/python/firewalls_add_tags.yml' + - $ref: "examples/curl/firewalls_add_tags.yml" + - $ref: "examples/go/firewalls_add_tags.yml" + - $ref: "examples/ruby/firewalls_add_tags.yml" + - $ref: "examples/python/firewalls_add_tags.yml" security: - bearer_auth: - - 'firewall:update' + - "firewall:update" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_delete_tags.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_delete_tags.yml index 5bd1d3e4f..c27b3b23e 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_delete_tags.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_delete_tags.yml @@ -15,7 +15,7 @@ tags: - Firewalls parameters: - - $ref: 'parameters.yml#/firewall_id' + - $ref: "parameters.yml#/firewall_id" requestBody: content: @@ -24,7 +24,7 @@ requestBody: properties: tags: allOf: - - $ref: '../../shared/attributes/tags_array.yml' + - $ref: "../../shared/attributes/existing_tags_array.yml" - description: >- An array containing the names of the Tags to be removed from the firewall. @@ -37,33 +37,33 @@ requestBody: - frontend responses: - '204': - $ref: '../../shared/responses/no_content.yml' + "204": + $ref: "../../shared/responses/no_content.yml" - '400': - $ref: '../../shared/responses/bad_request.yml' + "400": + $ref: "../../shared/responses/bad_request.yml" - '401': - $ref: '../../shared/responses/unauthorized.yml' + "401": + $ref: "../../shared/responses/unauthorized.yml" - '404': - $ref: '../../shared/responses/not_found.yml' + "404": + $ref: "../../shared/responses/not_found.yml" - '429': - $ref: '../../shared/responses/too_many_requests.yml' + "429": + $ref: "../../shared/responses/too_many_requests.yml" - '500': - $ref: '../../shared/responses/server_error.yml' + "500": + $ref: "../../shared/responses/server_error.yml" default: - $ref: '../../shared/responses/unexpected_error.yml' + $ref: "../../shared/responses/unexpected_error.yml" x-codeSamples: - - $ref: 'examples/curl/firewalls_delete_tags.yml' - - $ref: 'examples/go/firewalls_delete_tags.yml' - - $ref: 'examples/ruby/firewalls_delete_tags.yml' - - $ref: 'examples/python/firewalls_delete_tags.yml' + - $ref: "examples/curl/firewalls_delete_tags.yml" + - $ref: "examples/go/firewalls_delete_tags.yml" + - $ref: "examples/ruby/firewalls_delete_tags.yml" + - $ref: "examples/python/firewalls_delete_tags.yml" security: - bearer_auth: - - 'firewall:update' + - "firewall:update" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/models/firewall.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/models/firewall.yml index 6be23a8bb..821b75121 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/models/firewall.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/models/firewall.yml @@ -28,7 +28,7 @@ allOf: A time value given in ISO8601 combined date and time format that represents when the firewall was created. readOnly: true - example: '2020-05-23T21:24:00Z' + example: "2020-05-23T21:24:00Z" pending_changes: type: array @@ -78,9 +78,9 @@ allOf: tags: allOf: - - $ref: '../../../shared/attributes/tags_array.yml' + - $ref: "../../../shared/attributes/existing_tags_array.yml" - description: >- An array containing the names of the Tags assigned to the firewall. example: gateway - - $ref: 'firewall_rule.yml#/firewall_rules' \ No newline at end of file + - $ref: "firewall_rule.yml#/firewall_rules" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/models/firewall_rule.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/models/firewall_rule.yml index deb5512e0..3535b5a93 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/models/firewall_rule.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/models/firewall_rule.yml @@ -20,7 +20,7 @@ firewall_rule_base: containing a single port, a range (e.g. "8000-9000"), or "0" when all ports are open for a protocol. For ICMP rules this parameter will always return "0". - example: '8000' + example: "8000" required: - protocol @@ -39,8 +39,8 @@ firewall_rule_target: An array of strings containing the IPv4 addresses, IPv6 addresses, IPv4 CIDRs, and/or IPv6 CIDRs to which the firewall will allow traffic. example: - - '1.2.3.4' - - '18.0.0.0/8' + - "1.2.3.4" + - "18.0.0.0/8" droplet_ids: type: array @@ -74,7 +74,7 @@ firewall_rule_target: tags: allOf: - - $ref: '../../../shared/attributes/tags_array.yml' + - $ref: "../../../shared/attributes/existing_tags_array.yml" - description: >- An array containing the names of Tags corresponding to groups of Droplets to which the firewall will allow traffic. @@ -90,11 +90,11 @@ firewall_rules: type: array items: allOf: - - $ref: '#/firewall_rule_base' + - $ref: "#/firewall_rule_base" - properties: sources: allOf: - - $ref: '#/firewall_rule_target' + - $ref: "#/firewall_rule_target" - description: >- An object specifying locations from which inbound traffic will be accepted. @@ -106,11 +106,11 @@ firewall_rules: type: array items: allOf: - - $ref: '#/firewall_rule_base' + - $ref: "#/firewall_rule_base" - properties: destinations: allOf: - - $ref: '#/firewall_rule_target' + - $ref: "#/firewall_rule_target" - description: >- An object specifying locations to which outbound traffic that will be allowed. diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/models/load_balancer_base.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/models/load_balancer_base.yml index 73265f81b..e5a6fb1b5 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/models/load_balancer_base.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/models/load_balancer_base.yml @@ -169,5 +169,17 @@ properties: to resources on the same VPC network. This property cannot be updated after creating the load balancer. + type: + type: string + example: REGIONAL + enum: + - REGIONAL + - REGIONAL_NETWORK + - GLOBAL + default: REGIONAL + description: A string indicating whether the load balancer should be a standard + regional HTTP load balancer, a regional network load balancer that routes traffic + at the TCP/UDP transport layer, or a global load balancer. + required: - forwarding_rules diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ips/examples/go/create_reserved_ip.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ips/examples/go/create_reserved_ip.yml index 99756de4d..8984a5362 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ips/examples/go/create_reserved_ip.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ips/examples/go/create_reserved_ip.yml @@ -8,13 +8,16 @@ source: |- ) func main() { - token := os.Getenv("DIGITALOCEAN_TOKEN") + token := os.Getenv("DIGITALOCEAN_TOKEN") - client := godo.NewFromToken(token) - ctx := context.TODO() + client := godo.NewFromToken(token) + ctx := context.TODO() - createRequest := &godo.ReservedIPCreateRequest{ - DropletID: 123456, + createRequest := &godo.ReservedIPCreateRequest{ + DropletID: 123456, + Region: "nyc3", + ProjectID: "1234a77a-12cd-11ed-909f-43c99lbf6030", + } - } + reservedIP, _, err := client.ReservedIPs.Create(ctx, createRequest) } diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ips/examples/go/post_reserved_ip_action.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ips/examples/go/post_reserved_ip_action.yml index 88c2d4f14..ce0d37990 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ips/examples/go/post_reserved_ip_action.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ips/examples/go/post_reserved_ip_action.yml @@ -17,5 +17,5 @@ source: |- action, _, err := client.ReservedIPActions.Assign(ctx, "45.55.96.47", 8219222) // Unassign a Reserved IP - // action, _, err := client.ReservedIPActions.Unassign(ctx, "45.55.96.47") + action, _, err := client.ReservedIPActions.Unassign(ctx, "45.55.96.47") } diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/tags/examples/python/tags_create.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/tags/examples/python/tags_create.yml index 86bad4b2e..0f4109830 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/tags/examples/python/tags_create.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/tags/examples/python/tags_create.yml @@ -5,28 +5,6 @@ source: |- client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN")) - req = { - "tag": { - "name": "extra-awesome", - "resources": { - "count": 0, - "droplets": { - "count": 0 - }, - "images": { - "count": 0 - }, - "volumes": { - "count": 0 - }, - "volume_snapshots": { - "count": 0 - }, - "databases": { - "count": 0 - } - } - } - } + req = {"name": "extra-awesome"} resp = client.tags.create(body=req) diff --git a/packages/openapi-typescript/examples/digital-ocean-api/shared/attributes/existing_tags_array.yml b/packages/openapi-typescript/examples/digital-ocean-api/shared/attributes/existing_tags_array.yml new file mode 100644 index 000000000..28c77d7da --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/shared/attributes/existing_tags_array.yml @@ -0,0 +1,10 @@ +type: array +items: + type: string +nullable: true +description: >- + A flat array of tag names as strings to be applied to the resource. + Tag names must exist in order to be referenced in a request. +example: + - base-image + - prod diff --git a/packages/openapi-typescript/examples/digital-ocean-api/shared/attributes/tags_array.yml b/packages/openapi-typescript/examples/digital-ocean-api/shared/attributes/tags_array.yml index a4f8c59ce..8243341c7 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/shared/attributes/tags_array.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/shared/attributes/tags_array.yml @@ -7,4 +7,4 @@ description: >- Tag names may be for either existing or new tags. example: - base-image - - prod \ No newline at end of file + - prod diff --git a/packages/openapi-typescript/examples/github-api-export-type-immutable.ts b/packages/openapi-typescript/examples/github-api-export-type-immutable.ts index 6a18d8275..a155755c4 100644 --- a/packages/openapi-typescript/examples/github-api-export-type-immutable.ts +++ b/packages/openapi-typescript/examples/github-api-export-type-immutable.ts @@ -289,8 +289,6 @@ export type paths = { * * Optionally, use the `permissions` body parameter to specify the permissions that the installation access token should have. If `permissions` is not specified, the installation access token will have all of the permissions that were granted to the app. The installation access token cannot be granted permissions that the app was not granted. * - * When using the repository or permission parameters to reduce the access of the token, the complexity of the token is increased due to both the number of permissions in the request and the number of repositories the token will have access to. If the complexity is too large, the token will fail to be issued. If this occurs, the error message will indicate the maximum number of repositories that should be requested. For the average application requesting 8 permissions, this limit is around 5000 repositories. With fewer permissions requested, more repositories are supported. - * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ readonly post: operations["apps/create-installation-access-token"]; @@ -602,7 +600,7 @@ export type paths = { readonly patch?: never; readonly trace?: never; }; - readonly "/enterprises/{enterprise}/copilot/billing/seats": { + readonly "/enterprises/{enterprise}/code-security/configurations": { readonly parameters: { readonly query?: never; readonly header?: never; @@ -610,33 +608,31 @@ export type paths = { readonly cookie?: never; }; /** - * List all Copilot seat assignments for an enterprise - * @description > [!NOTE] - * > This endpoint is in public preview and is subject to change. + * Get code security configurations for an enterprise + * @description Lists all code security configurations available in an enterprise. * - * Lists all Copilot seats currently being billed for across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription. + * The authenticated user must be an administrator of the enterprise in order to use this endpoint. * - * Users with access through multiple organizations or enterprise teams will only be counted toward `total_seats` once. - * - * For each organization or enterprise team which grants Copilot access to a user, a seat detail object will appear in the `seats` array. - * Each seat object contains information about the assigned user's most recent Copilot activity. Users must have - * telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. For more information about activity data, - * see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." + * OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. + */ + readonly get: operations["code-security/get-configurations-for-enterprise"]; + readonly put?: never; + /** + * Create a code security configuration for an enterprise + * @description Creates a code security configuration in an enterprise. * - * Only enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams. + * The authenticated user must be an administrator of the enterprise in order to use this endpoint. * - * Personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ - readonly get: operations["copilot/list-copilot-seats-for-enterprise"]; - readonly put?: never; - readonly post?: never; + readonly post: operations["code-security/create-configuration-for-enterprise"]; readonly delete?: never; readonly options?: never; readonly head?: never; readonly patch?: never; readonly trace?: never; }; - readonly "/enterprises/{enterprise}/copilot/metrics": { + readonly "/enterprises/{enterprise}/code-security/configurations/defaults": { readonly parameters: { readonly query?: never; readonly header?: never; @@ -644,19 +640,14 @@ export type paths = { readonly cookie?: never; }; /** - * Get Copilot metrics for an enterprise - * @description Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. - * - * The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, - * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, - * they must have telemetry enabled in their IDE. + * Get default code security configurations for an enterprise + * @description Lists the default code security configurations for an enterprise. * - * To access this endpoint, the Copilot Metrics API access policy must be enabled or set to "no policy" for the enterprise within GitHub settings. - * Only enterprise owners and billing managers can view Copilot metrics for the enterprise. + * The authenticated user must be an administrator of the enterprise in order to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. */ - readonly get: operations["copilot/copilot-metrics-for-enterprise"]; + readonly get: operations["code-security/get-default-configurations-for-enterprise"]; readonly put?: never; readonly post?: never; readonly delete?: never; @@ -665,7 +656,7 @@ export type paths = { readonly patch?: never; readonly trace?: never; }; - readonly "/enterprises/{enterprise}/copilot/usage": { + readonly "/enterprises/{enterprise}/code-security/configurations/{configuration_id}": { readonly parameters: { readonly query?: never; readonly header?: never; @@ -673,52 +664,85 @@ export type paths = { readonly cookie?: never; }; /** - * Get a summary of Copilot usage for enterprise members - * @description > [!NOTE] - * > This endpoint is in public preview and is subject to change. + * Retrieve a code security configuration of an enterprise + * @description Gets a code security configuration available in an enterprise. * - * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE - * for all users across organizations with access to Copilot within your enterprise, with a further breakdown of suggestions, acceptances, - * and number of active users by editor and language for each day. See the response schema tab for detailed metrics definitions. + * The authenticated user must be an administrator of the enterprise in order to use this endpoint. * - * The response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day, - * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, - * they must have telemetry enabled in their IDE. + * OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. + */ + readonly get: operations["code-security/get-single-configuration-for-enterprise"]; + readonly put?: never; + readonly post?: never; + /** + * Delete a code security configuration for an enterprise + * @description Deletes a code security configuration from an enterprise. + * Repositories attached to the configuration will retain their settings but will no longer be associated with + * the configuration. + * + * The authenticated user must be an administrator for the enterprise to use this endpoint. * - * The time zone in the response is in UTC time, that means that the cutoff time for the "day" is UTC time. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + */ + readonly delete: operations["code-security/delete-configuration-for-enterprise"]; + readonly options?: never; + readonly head?: never; + /** + * Update a custom code security configuration for an enterprise + * @description Updates a code security configuration in an enterprise. * - * Only owners and billing managers can view Copilot usage metrics for the enterprise. + * The authenticated user must be an administrator of the enterprise in order to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ - readonly get: operations["copilot/usage-metrics-for-enterprise"]; + readonly patch: operations["code-security/update-enterprise-configuration"]; + readonly trace?: never; + }; + readonly "/enterprises/{enterprise}/code-security/configurations/{configuration_id}/attach": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + readonly get?: never; readonly put?: never; - readonly post?: never; + /** + * Attach an enterprise configuration to repositories + * @description Attaches an enterprise code security configuration to repositories. If the repositories specified are already attached to a configuration, they will be re-attached to the provided configuration. + * + * If insufficient GHAS licenses are available to attach the configuration to a repository, only free features will be enabled. + * + * The authenticated user must be an administrator for the enterprise to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + */ + readonly post: operations["code-security/attach-enterprise-configuration"]; readonly delete?: never; readonly options?: never; readonly head?: never; readonly patch?: never; readonly trace?: never; }; - readonly "/enterprises/{enterprise}/dependabot/alerts": { + readonly "/enterprises/{enterprise}/code-security/configurations/{configuration_id}/defaults": { readonly parameters: { readonly query?: never; readonly header?: never; readonly path?: never; readonly cookie?: never; }; + readonly get?: never; /** - * List Dependabot alerts for an enterprise - * @description Lists Dependabot alerts for repositories that are owned by the specified enterprise. + * Set a code security configuration as a default for an enterprise + * @description Sets a code security configuration as a default to be applied to new repositories in your enterprise. * - * The authenticated user must be a member of the enterprise to use this endpoint. + * This configuration will be applied by default to the matching repository type when created, but only for organizations within the enterprise that do not already have a default code security configuration set. * - * Alerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager. For more information about security managers, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * The authenticated user must be an administrator for the enterprise to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ - readonly get: operations["dependabot/list-alerts-for-enterprise"]; - readonly put?: never; + readonly put: operations["code-security/set-configuration-as-default-for-enterprise"]; readonly post?: never; readonly delete?: never; readonly options?: never; @@ -726,7 +750,7 @@ export type paths = { readonly patch?: never; readonly trace?: never; }; - readonly "/enterprises/{enterprise}/secret-scanning/alerts": { + readonly "/enterprises/{enterprise}/code-security/configurations/{configuration_id}/repositories": { readonly parameters: { readonly query?: never; readonly header?: never; @@ -734,16 +758,14 @@ export type paths = { readonly cookie?: never; }; /** - * List secret scanning alerts for an enterprise - * @description Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest. - * - * Alerts are only returned for organizations in the enterprise for which the authenticated user is an organization owner or a [security manager](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization). + * Get repositories associated with an enterprise code security configuration + * @description Lists the repositories associated with an enterprise code security configuration in an organization. * - * The authenticated user must be a member of the enterprise in order to use this endpoint. + * The authenticated user must be an administrator of the enterprise in order to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope or `security_events` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. */ - readonly get: operations["secret-scanning/list-alerts-for-enterprise"]; + readonly get: operations["code-security/get-repositories-for-enterprise-configuration"]; readonly put?: never; readonly post?: never; readonly delete?: never; @@ -752,7 +774,7 @@ export type paths = { readonly patch?: never; readonly trace?: never; }; - readonly "/enterprises/{enterprise}/team/{team_slug}/copilot/metrics": { + readonly "/enterprises/{enterprise}/dependabot/alerts": { readonly parameters: { readonly query?: never; readonly header?: never; @@ -760,22 +782,16 @@ export type paths = { readonly cookie?: never; }; /** - * Get Copilot metrics for an enterprise team - * @description Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. - * - * The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, - * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, - * they must have telemetry enabled in their IDE. + * List Dependabot alerts for an enterprise + * @description Lists Dependabot alerts for repositories that are owned by the specified enterprise. * - * > [!NOTE] - * > This endpoint will only return results for a given day if the enterprise team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day. + * The authenticated user must be a member of the enterprise to use this endpoint. * - * To access this endpoint, the Copilot Metrics API access policy must be enabled or set to "no policy" for the enterprise within GitHub settings. - * Only owners and billing managers for the enterprise that contains the enterprise team can view Copilot metrics for the enterprise team. + * Alerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager. For more information about security managers, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. */ - readonly get: operations["copilot/copilot-metrics-for-enterprise-team"]; + readonly get: operations["dependabot/list-alerts-for-enterprise"]; readonly put?: never; readonly post?: never; readonly delete?: never; @@ -784,7 +800,7 @@ export type paths = { readonly patch?: never; readonly trace?: never; }; - readonly "/enterprises/{enterprise}/team/{team_slug}/copilot/usage": { + readonly "/enterprises/{enterprise}/secret-scanning/alerts": { readonly parameters: { readonly query?: never; readonly header?: never; @@ -792,26 +808,16 @@ export type paths = { readonly cookie?: never; }; /** - * Get a summary of Copilot usage for an enterprise team - * @description > [!NOTE] - * > This endpoint is in public preview and is subject to change. - * - * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE - * for users within an enterprise team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day. - * See the response schema tab for detailed metrics definitions. - * - * The response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day, - * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, - * they must have telemetry enabled in their IDE. + * List secret scanning alerts for an enterprise + * @description Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest. * - * > [!NOTE] - * > This endpoint will only return results for a given day if the enterprise team had five or more members with active Copilot licenses, as evaluated at the end of that day. + * Alerts are only returned for organizations in the enterprise for which the authenticated user is an organization owner or a [security manager](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization). * - * Owners and billing managers for the enterprise that contains the enterprise team can view Copilot usage metrics for the enterprise team. + * The authenticated user must be a member of the enterprise in order to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope or `security_events` scope to use this endpoint. */ - readonly get: operations["copilot/usage-metrics-for-enterprise-team"]; + readonly get: operations["secret-scanning/list-alerts-for-enterprise"]; readonly put?: never; readonly post?: never; readonly delete?: never; @@ -1637,6 +1643,28 @@ export type paths = { readonly patch?: never; readonly trace?: never; }; + readonly "/organizations/{org}/settings/billing/usage": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Get billing usage report for an organization + * @description Gets a report of the total usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account. + * + * **Note:** This endpoint is only available to organizations with access to the enhanced billing platform. For more information, see "[About the enhanced billing platform](https://docs.github.com/billing/using-the-new-billing-platform)." + */ + readonly get: operations["billing/get-github-billing-usage-report-org"]; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; readonly "/orgs/{org}": { readonly parameters: { readonly query?: never; @@ -3217,13 +3245,11 @@ export type paths = { * Purchases a GitHub Copilot seat for all users within each specified team. * The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." * - * Only organization owners can add Copilot seats for their organization members. - * - * In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy. + * Only organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy. * For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." * For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." * - * The response will contain the total number of new seats that were created and existing seats that were refreshed. + * The response contains the total number of new seats that were created and existing seats that were refreshed. * * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. */ @@ -3235,14 +3261,11 @@ export type paths = { * * Sets seats for all members of each team specified to "pending cancellation". * This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team. - * - * For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." - * - * For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." + * For more information about disabling access to Copilot, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." * * Only organization owners can cancel Copilot seats for their organization members. * - * The response will contain the total number of seats set to "pending cancellation". + * The response contains the total number of seats set to "pending cancellation". * * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. */ @@ -3269,13 +3292,11 @@ export type paths = { * Purchases a GitHub Copilot seat for each user specified. * The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." * - * Only organization owners can add Copilot seats for their organization members. - * - * In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy. + * Only organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy. * For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." * For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." * - * The response will contain the total number of new seats that were created and existing seats that were refreshed. + * The response contains the total number of new seats that were created and existing seats that were refreshed. * * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. */ @@ -3287,14 +3308,11 @@ export type paths = { * * Sets seats for all users specified to "pending cancellation". * This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership. - * - * For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." - * - * For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." + * For more information about disabling access to Copilot, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." * * Only organization owners can cancel Copilot seats for their organization members. * - * The response will contain the total number of seats set to "pending cancellation". + * The response contains the total number of seats set to "pending cancellation". * * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. */ @@ -3609,7 +3627,9 @@ export type paths = { }; /** * List organization webhooks - * @description You must be an organization owner to use this endpoint. + * @description List webhooks for an organization. + * + * The authenticated user must be an organization owner to use this endpoint. * * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. @@ -3654,7 +3674,9 @@ export type paths = { readonly post?: never; /** * Delete an organization webhook - * @description You must be an organization owner to use this endpoint. + * @description Delete a webhook for an organization. + * + * The authenticated user must be an organization owner to use this endpoint. * * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. @@ -5027,6 +5049,109 @@ export type paths = { readonly patch?: never; readonly trace?: never; }; + readonly "/orgs/{org}/private-registries": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * List private registries for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Lists all private registry configurations available at the organization-level without revealing their encrypted + * values. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + readonly get: operations["private-registries/list-org-private-registries"]; + readonly put?: never; + /** + * Create a private registry for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Creates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + readonly post: operations["private-registries/create-org-private-registry"]; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; + readonly "/orgs/{org}/private-registries/public-key": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Get private registries public key for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Gets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets. + * + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + readonly get: operations["private-registries/get-org-public-key"]; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; + readonly "/orgs/{org}/private-registries/{secret_name}": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Get a private registry for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Get the configuration of a single private registry defined for an organization, omitting its encrypted value. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + readonly get: operations["private-registries/get-org-private-registry"]; + readonly put?: never; + readonly post?: never; + /** + * Delete a private registry for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Delete a private registry configuration at the organization-level. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + readonly delete: operations["private-registries/delete-org-private-registry"]; + readonly options?: never; + readonly head?: never; + /** + * Update a private registry for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + readonly patch: operations["private-registries/update-org-private-registry"]; + readonly trace?: never; + }; readonly "/orgs/{org}/projects": { readonly parameters: { readonly query?: never; @@ -5384,11 +5509,9 @@ export type paths = { }; /** * List security manager teams - * @description Lists teams that are security managers for an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." - * - * The authenticated user must be an administrator or security manager for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the "[Organization Roles](https://docs.github.com/rest/orgs/organization-roles)" endpoints instead. */ readonly get: operations["orgs/list-security-manager-teams"]; readonly put?: never; @@ -5409,21 +5532,17 @@ export type paths = { readonly get?: never; /** * Add a security manager team - * @description Adds a team as a security manager for an organization. For more information, see "[Managing security for an organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) for an organization." - * - * The authenticated user must be an administrator for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the "[Organization Roles](https://docs.github.com/rest/orgs/organization-roles)" endpoints instead. */ readonly put: operations["orgs/add-security-manager-team"]; readonly post?: never; /** * Remove a security manager team - * @description Removes the security manager role from a team for an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) team from an organization." - * - * The authenticated user must be an administrator for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the "[Organization Roles](https://docs.github.com/rest/orgs/organization-roles)" endpoints instead. */ readonly delete: operations["orgs/remove-security-manager-team"]; readonly options?: never; @@ -7166,7 +7285,7 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. * - * This API will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`. + * This endpoint will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`. */ readonly get: operations["actions/list-workflow-runs-for-repo"]; readonly put?: never; @@ -7871,6 +7990,8 @@ export type paths = { * Anyone with read access to the repository can use this endpoint * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * + * This endpoint will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`. */ readonly get: operations["actions/list-workflow-runs"]; readonly put?: never; @@ -8806,6 +8927,62 @@ export type paths = { readonly patch: operations["code-scanning/update-alert"]; readonly trace?: never; }; + readonly "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/autofix": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Get the status of an autofix for a code scanning alert + * @description Gets the status and description of an autofix for a code scanning alert. + * + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + */ + readonly get: operations["code-scanning/get-autofix"]; + readonly put?: never; + /** + * Create an autofix for a code scanning alert + * @description Creates an autofix for a code scanning alert. + * + * If a new autofix is to be created as a result of this request or is currently being generated, then this endpoint will return a 202 Accepted response. + * + * If an autofix already exists for a given alert, then this endpoint will return a 200 OK response. + * + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + */ + readonly post: operations["code-scanning/create-autofix"]; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; + readonly "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/autofix/commits": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + readonly get?: never; + readonly put?: never; + /** + * Commit an autofix for a code scanning alert + * @description Commits an autofix for a code scanning alert. + * + * If an autofix is commited as a result of this request, then this endpoint will return a 201 Created response. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + */ + readonly post: operations["code-scanning/commit-autofix"]; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; readonly "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances": { readonly parameters: { readonly query?: never; @@ -9700,6 +9877,7 @@ export type paths = { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -9842,6 +10020,7 @@ export type paths = { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -10042,6 +10221,7 @@ export type paths = { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -11026,6 +11206,7 @@ export type paths = { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -11075,6 +11256,7 @@ export type paths = { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -11220,6 +11402,7 @@ export type paths = { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -11265,6 +11448,7 @@ export type paths = { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -11381,7 +11565,12 @@ export type paths = { readonly get: operations["repos/get-webhook"]; readonly put?: never; readonly post?: never; - /** Delete a repository webhook */ + /** + * Delete a repository webhook + * @description Delete a webhook for an organization. + * + * The authenticated user must be a repository owner, or have admin access in the repository, to delete the webhook. + */ readonly delete: operations["repos/delete-webhook"]; readonly options?: never; readonly head?: never; @@ -12288,6 +12477,96 @@ export type paths = { readonly patch?: never; readonly trace?: never; }; + readonly "/repos/{owner}/{repo}/issues/{issue_number}/sub_issue": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + readonly get?: never; + readonly put?: never; + readonly post?: never; + /** + * Remove sub-issue + * @description You can use the REST API to remove a sub-issue from an issue. + * Removing content too quickly using this endpoint may result in secondary rate limiting. + * For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass a specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + */ + readonly delete: operations["issues/remove-sub-issue"]; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; + readonly "/repos/{owner}/{repo}/issues/{issue_number}/sub_issues": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * List sub-issues + * @description You can use the REST API to list the sub-issues on an issue. + * + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + */ + readonly get: operations["issues/list-sub-issues"]; + readonly put?: never; + /** + * Add sub-issue + * @description You can use the REST API to add sub-issues to issues. + * + * Creating content too quickly using this endpoint may result in secondary rate limiting. + * For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + * + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + */ + readonly post: operations["issues/add-sub-issue"]; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; + readonly "/repos/{owner}/{repo}/issues/{issue_number}/sub_issues/priority": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + readonly get?: never; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + /** + * Reprioritize sub-issue + * @description You can use the REST API to reprioritize a sub-issue to a different position in the parent list. + */ + readonly patch: operations["issues/reprioritize-sub-issue"]; + readonly trace?: never; + }; readonly "/repos/{owner}/{repo}/issues/{issue_number}/timeline": { readonly parameters: { readonly query?: never; @@ -13586,7 +13865,13 @@ export type paths = { }; /** * Get a release asset - * @description To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response. + * @description To download the asset's binary content: + * + * - If within a browser, fetch the location specified in the `browser_download_url` key provided in the response. + * - Alternatively, set the `Accept` header of the request to + * [`application/octet-stream`](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + * The API will either redirect the client to the location, or stream it directly if possible. + * API clients should handle both a `200` or `302` response. */ readonly get: operations["repos/get-release-asset"]; readonly put?: never; @@ -14005,6 +14290,28 @@ export type paths = { readonly patch?: never; readonly trace?: never; }; + readonly "/repos/{owner}/{repo}/secret-scanning/scan-history": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Get secret scanning scan history for a repository + * @description Lists the latest incremental and backfill scans by type for a repository. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + */ + readonly get: operations["secret-scanning/get-scan-history"]; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; readonly "/repos/{owner}/{repo}/security-advisories": { readonly parameters: { readonly query?: never; @@ -19792,394 +20099,396 @@ export type components = { /** Format: uri */ readonly html_url: string | null; }; - /** - * Organization Simple - * @description A GitHub organization. - */ - readonly "nullable-organization-simple": { - /** @example github */ - readonly login: string; - /** @example 1 */ - readonly id: number; - /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ - readonly node_id: string; + /** @description A code security configuration */ + readonly "code-security-configuration": { + /** @description The ID of the code security configuration */ + readonly id?: number; + /** @description The name of the code security configuration. Must be unique within the organization. */ + readonly name?: string; /** - * Format: uri - * @example https://api.github.com/orgs/github + * @description The type of the code security configuration. + * @enum {string} */ - readonly url: string; + readonly target_type?: "global" | "organization" | "enterprise"; + /** @description A description of the code security configuration */ + readonly description?: string; + /** + * @description The enablement status of GitHub Advanced Security + * @enum {string} + */ + readonly advanced_security?: "enabled" | "disabled"; + /** + * @description The enablement status of Dependency Graph + * @enum {string} + */ + readonly dependency_graph?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Automatic dependency submission + * @enum {string} + */ + readonly dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for Automatic dependency submission */ + readonly dependency_graph_autosubmit_action_options?: { + /** @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. */ + readonly labeled_runners?: boolean; + }; + /** + * @description The enablement status of Dependabot alerts + * @enum {string} + */ + readonly dependabot_alerts?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot security updates + * @enum {string} + */ + readonly dependabot_security_updates?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of code scanning default setup + * @enum {string} + */ + readonly code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for code scanning default setup */ + readonly code_scanning_default_setup_options?: { + /** + * @description Whether to use labeled runners or standard GitHub runners. + * @enum {string|null} + */ + readonly runner_type?: "standard" | "labeled" | "not_set" | null; + /** @description The label of the runner to use for code scanning when runner_type is 'labeled'. */ + readonly runner_label?: string | null; + } | null; + /** + * @description The enablement status of secret scanning + * @enum {string} + */ + readonly secret_scanning?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning push protection + * @enum {string} + */ + readonly secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning delegated bypass + * @enum {string} + */ + readonly secret_scanning_delegated_bypass?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for secret scanning delegated bypass */ + readonly secret_scanning_delegated_bypass_options?: { + /** @description The bypass reviewers for secret scanning delegated bypass */ + readonly reviewers?: readonly { + /** @description The ID of the team or role selected as a bypass reviewer */ + readonly reviewer_id: number; + /** + * @description The type of the bypass reviewer + * @enum {string} + */ + readonly reviewer_type: "TEAM" | "ROLE"; + }[]; + }; + /** + * @description The enablement status of secret scanning validity checks + * @enum {string} + */ + readonly secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning non-provider patterns + * @enum {string} + */ + readonly secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of private vulnerability reporting + * @enum {string} + */ + readonly private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; + /** + * @description The enforcement status for a security configuration + * @enum {string} + */ + readonly enforcement?: "enforced" | "unenforced"; /** * Format: uri - * @example https://api.github.com/orgs/github/repos + * @description The URL of the configuration */ - readonly repos_url: string; + readonly url?: string; /** * Format: uri - * @example https://api.github.com/orgs/github/events + * @description The URL of the configuration */ - readonly events_url: string; - /** @example https://api.github.com/orgs/github/hooks */ - readonly hooks_url: string; - /** @example https://api.github.com/orgs/github/issues */ - readonly issues_url: string; - /** @example https://api.github.com/orgs/github/members{/member} */ - readonly members_url: string; - /** @example https://api.github.com/orgs/github/public_members{/member} */ - readonly public_members_url: string; - /** @example https://github.com/images/error/octocat_happy.gif */ - readonly avatar_url: string; - /** @example A great organization */ - readonly description: string | null; + readonly html_url?: string; + /** Format: date-time */ + readonly created_at?: string; + /** Format: date-time */ + readonly updated_at?: string; + }; + /** @description Feature options for code scanning default setup */ + readonly "code-scanning-default-setup-options": { + /** + * @description Whether to use labeled runners or standard GitHub runners. + * @enum {string} + */ + readonly runner_type?: "standard" | "labeled" | "not_set"; + /** @description The label of the runner to use for code scanning default setup when runner_type is 'labeled'. */ + readonly runner_label?: string | null; } | null; + /** @description A list of default code security configurations */ + readonly "code-security-default-configurations": readonly { + /** + * @description The visibility of newly created repositories for which the code security configuration will be applied to by default + * @enum {unknown} + */ + readonly default_for_new_repos?: "public" | "private_and_internal" | "all"; + readonly configuration?: components["schemas"]["code-security-configuration"]; + }[]; /** - * Team Simple - * @description Groups of organization members that gives permissions on specified repositories. + * Simple Repository + * @description A GitHub repository. */ - readonly "nullable-team-simple": { + readonly "simple-repository": { /** - * @description Unique identifier of the team - * @example 1 + * Format: int64 + * @description A unique identifier of the repository. + * @example 1296269 */ readonly id: number; - /** @example MDQ6VGVhbTE= */ + /** + * @description The GraphQL identifier of the repository. + * @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + */ readonly node_id: string; + /** + * @description The name of the repository. + * @example Hello-World + */ + readonly name: string; + /** + * @description The full, globally unique, name of the repository. + * @example octocat/Hello-World + */ + readonly full_name: string; + readonly owner: components["schemas"]["simple-user"]; + /** @description Whether the repository is private. */ + readonly private: boolean; /** * Format: uri - * @description URL for the team - * @example https://api.github.com/organizations/1/team/1 + * @description The URL to view the repository on GitHub.com. + * @example https://github.com/octocat/Hello-World + */ + readonly html_url: string; + /** + * @description The repository description. + * @example This your first repo! + */ + readonly description: string | null; + /** @description Whether the repository is a fork. */ + readonly fork: boolean; + /** + * Format: uri + * @description The URL to get more information about the repository from the GitHub API. + * @example https://api.github.com/repos/octocat/Hello-World */ readonly url: string; - /** @example https://api.github.com/organizations/1/team/1/members{/member} */ - readonly members_url: string; /** - * @description Name of the team - * @example Justice League + * @description A template for the API URL to download the repository as an archive. + * @example https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ - readonly name: string; + readonly archive_url: string; /** - * @description Description of the team - * @example A great team. + * @description A template for the API URL to list the available assignees for issues in the repository. + * @example https://api.github.com/repos/octocat/Hello-World/assignees{/user} */ - readonly description: string | null; + readonly assignees_url: string; /** - * @description Permission that the team will have for its repositories - * @example admin + * @description A template for the API URL to create or retrieve a raw Git blob in the repository. + * @example https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} */ - readonly permission: string; + readonly blobs_url: string; /** - * @description The level of privacy this team should have - * @example closed + * @description A template for the API URL to get information about branches in the repository. + * @example https://api.github.com/repos/octocat/Hello-World/branches{/branch} */ - readonly privacy?: string; + readonly branches_url: string; /** - * @description The notification setting the team has set - * @example notifications_enabled + * @description A template for the API URL to get information about collaborators of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} */ - readonly notification_setting?: string; + readonly collaborators_url: string; + /** + * @description A template for the API URL to get information about comments on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/comments{/number} + */ + readonly comments_url: string; + /** + * @description A template for the API URL to get information about commits on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/commits{/sha} + */ + readonly commits_url: string; + /** + * @description A template for the API URL to compare two commits or refs. + * @example https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + */ + readonly compare_url: string; + /** + * @description A template for the API URL to get the contents of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/contents/{+path} + */ + readonly contents_url: string; /** * Format: uri - * @example https://github.com/orgs/rails/teams/core + * @description A template for the API URL to list the contributors to the repository. + * @example https://api.github.com/repos/octocat/Hello-World/contributors */ - readonly html_url: string; + readonly contributors_url: string; /** * Format: uri - * @example https://api.github.com/organizations/1/team/1/repos + * @description The API URL to list the deployments of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/deployments */ - readonly repositories_url: string; - /** @example justice-league */ - readonly slug: string; + readonly deployments_url: string; /** - * @description Distinguished Name (DN) that team maps to within LDAP environment - * @example uid=example,ou=users,dc=github,dc=com + * Format: uri + * @description The API URL to list the downloads on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/downloads */ - readonly ldap_dn?: string; - } | null; - /** - * Team - * @description Groups of organization members that gives permissions on specified repositories. - */ - readonly team: { - readonly id: number; - readonly node_id: string; - readonly name: string; - readonly slug: string; - readonly description: string | null; - readonly privacy?: string; - readonly notification_setting?: string; - readonly permission: string; - readonly permissions?: { - readonly pull: boolean; - readonly triage: boolean; - readonly push: boolean; - readonly maintain: boolean; - readonly admin: boolean; - }; - /** Format: uri */ - readonly url: string; + readonly downloads_url: string; /** * Format: uri - * @example https://github.com/orgs/rails/teams/core + * @description The API URL to list the events of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/events */ - readonly html_url: string; - readonly members_url: string; - /** Format: uri */ - readonly repositories_url: string; - readonly parent: components["schemas"]["nullable-team-simple"]; - }; - /** - * Enterprise Team - * @description Group of enterprise owners and/or members - */ - readonly "enterprise-team": { - /** Format: int64 */ - readonly id: number; - readonly name: string; - readonly slug: string; - /** Format: uri */ - readonly url: string; - /** @example disabled | all */ - readonly sync_to_organizations: string; - /** @example 62ab9291-fae2-468e-974b-7e45096d5021 */ - readonly group_id?: string | null; + readonly events_url: string; /** * Format: uri - * @example https://github.com/enterprises/dc/teams/justice-league + * @description The API URL to list the forks of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/forks */ - readonly html_url: string; - readonly members_url: string; - /** Format: date-time */ - readonly created_at: string; - /** Format: date-time */ - readonly updated_at: string; - }; - /** - * Copilot Business Seat Detail - * @description Information about a Copilot Business seat assignment for a user, team, or organization. - */ - readonly "copilot-seat-details": { - readonly assignee: components["schemas"]["simple-user"]; - readonly organization?: components["schemas"]["nullable-organization-simple"]; - /** @description The team through which the assignee is granted access to GitHub Copilot, if applicable. */ - readonly assigning_team?: (components["schemas"]["team"] | components["schemas"]["enterprise-team"]) | null; + readonly forks_url: string; /** - * Format: date - * @description The pending cancellation date for the seat, in `YYYY-MM-DD` format. This will be null unless the assignee's Copilot access has been canceled during the current billing cycle. If the seat has been cancelled, this corresponds to the start of the organization's next billing cycle. + * @description A template for the API URL to get information about Git commits of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ - readonly pending_cancellation_date?: string | null; + readonly git_commits_url: string; /** - * Format: date-time - * @description Timestamp of user's last GitHub Copilot activity, in ISO 8601 format. + * @description A template for the API URL to get information about Git refs of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} */ - readonly last_activity_at?: string | null; - /** @description Last editor that was used by the user for a GitHub Copilot completion. */ - readonly last_activity_editor?: string | null; + readonly git_refs_url: string; /** - * Format: date-time - * @description Timestamp of when the assignee was last granted access to GitHub Copilot, in ISO 8601 format. + * @description A template for the API URL to get information about Git tags of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} */ - readonly created_at: string; + readonly git_tags_url: string; /** - * Format: date-time - * @description Timestamp of when the assignee's GitHub Copilot access was last updated, in ISO 8601 format. + * @description A template for the API URL to get information about issue comments on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} */ - readonly updated_at?: string; + readonly issue_comment_url: string; /** - * @description The Copilot plan of the organization, or the parent enterprise, when applicable. - * @enum {string} + * @description A template for the API URL to get information about issue events on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/issues/events{/number} */ - readonly plan_type?: "business" | "enterprise" | "unknown"; - }; - /** @description Usage metrics for Copilot editor code completions in the IDE. */ - readonly "copilot-ide-code-completions": ({ - /** @description Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances. */ - readonly total_engaged_users?: number; - /** @description Code completion metrics for active languages. */ - readonly languages?: readonly { - /** @description Name of the language used for Copilot code completion suggestions. */ - readonly name?: string; - /** @description Number of users who accepted at least one Copilot code completion suggestion for the given language. Includes both full and partial acceptances. */ - readonly total_engaged_users?: number; - }[]; - readonly editors?: readonly ({ - /** @description Name of the given editor. */ - readonly name?: string; - /** @description Number of users who accepted at least one Copilot code completion suggestion for the given editor. Includes both full and partial acceptances. */ - readonly total_engaged_users?: number; - /** @description List of model metrics for custom models and the default model. */ - readonly models?: readonly { - /** @description Name of the language used for Copilot code completion suggestions, for the given editor. */ - readonly name?: string; - /** @description Indicates whether a model is custom or default. */ - readonly is_custom_model?: boolean; - /** @description The training date for the custom model. */ - readonly custom_model_training_date?: string | null; - /** @description Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances. */ - readonly total_engaged_users?: number; - /** @description Code completion metrics for active languages, for the given editor. */ - readonly languages?: readonly { - /** @description Name of the language used for Copilot code completion suggestions, for the given editor. */ - readonly name?: string; - /** @description Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language. Includes both full and partial acceptances. */ - readonly total_engaged_users?: number; - /** @description The number of Copilot code suggestions generated for the given editor, for the given language. */ - readonly total_code_suggestions?: number; - /** @description The number of Copilot code suggestions accepted for the given editor, for the given language. Includes both full and partial acceptances. */ - readonly total_code_acceptances?: number; - /** @description The number of lines of code suggested by Copilot code completions for the given editor, for the given language. */ - readonly total_code_lines_suggested?: number; - /** @description The number of lines of code accepted from Copilot code suggestions for the given editor, for the given language. */ - readonly total_code_lines_accepted?: number; - }[]; - }[]; - } & { - readonly [key: string]: unknown; - })[]; - } & { - readonly [key: string]: unknown; - }) | null; - /** @description Usage metrics for Copilot Chat in the IDE. */ - readonly "copilot-ide-chat": ({ - /** @description Total number of users who prompted Copilot Chat in the IDE. */ - readonly total_engaged_users?: number; - readonly editors?: readonly { - /** @description Name of the given editor. */ - readonly name?: string; - /** @description The number of users who prompted Copilot Chat in the specified editor. */ - readonly total_engaged_users?: number; - /** @description List of model metrics for custom models and the default model. */ - readonly models?: readonly { - /** @description Name of the language used for Copilot code completion suggestions, for the given editor. */ - readonly name?: string; - /** @description Indicates whether a model is custom or default. */ - readonly is_custom_model?: boolean; - /** @description The training date for the custom model. */ - readonly custom_model_training_date?: string | null; - /** @description The number of users who prompted Copilot Chat in the given editor and model. */ - readonly total_engaged_users?: number; - /** @description The total number of chats initiated by users in the given editor and model. */ - readonly total_chats?: number; - /** @description The number of times users accepted a code suggestion from Copilot Chat using the 'Insert Code' UI element, for the given editor. */ - readonly total_chat_insertion_events?: number; - /** @description The number of times users copied a code suggestion from Copilot Chat using the keyboard, or the 'Copy' UI element, for the given editor. */ - readonly total_chat_copy_events?: number; - }[]; - }[]; - } & { - readonly [key: string]: unknown; - }) | null; - /** @description Usage metrics for Copilot Chat in github.com */ - readonly "copilot-dotcom-chat": ({ - /** @description Total number of users who prompted Copilot Chat on github.com at least once. */ - readonly total_engaged_users?: number; - /** @description List of model metrics for a custom models and the default model. */ - readonly models?: readonly { - /** @description Name of the language used for Copilot code completion suggestions, for the given editor. */ - readonly name?: string; - /** @description Indicates whether a model is custom or default. */ - readonly is_custom_model?: boolean; - /** @description The training date for the custom model (if applicable). */ - readonly custom_model_training_date?: string | null; - /** @description Total number of users who prompted Copilot Chat on github.com at least once for each model. */ - readonly total_engaged_users?: number; - /** @description Total number of chats initiated by users on github.com. */ - readonly total_chats?: number; - }[]; - } & { - readonly [key: string]: unknown; - }) | null; - /** @description Usage metrics for Copilot for pull requests. */ - readonly "copilot-dotcom-pull-requests": ({ - /** @description The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once. */ - readonly total_engaged_users?: number; - /** @description Repositories in which users used Copilot for Pull Requests to generate pull request summaries */ - readonly repositories?: readonly { - /** @description Repository name */ - readonly name?: string; - /** @description The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository. */ - readonly total_engaged_users?: number; - /** @description List of model metrics for custom models and the default model. */ - readonly models?: readonly { - /** @description Name of the language used for Copilot code completion suggestions, for the given editor. */ - readonly name?: string; - /** @description Indicates whether a model is custom or default. */ - readonly is_custom_model?: boolean; - /** @description The training date for the custom model. */ - readonly custom_model_training_date?: string | null; - /** @description The number of pull request summaries generated using Copilot for Pull Requests in the given repository. */ - readonly total_pr_summaries_created?: number; - /** @description The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository and model. */ - readonly total_engaged_users?: number; - }[]; - }[]; - } & { - readonly [key: string]: unknown; - }) | null; - /** - * Copilot Usage Metrics - * @description Copilot usage metrics for a given day. - */ - readonly "copilot-usage-metrics-day": { + readonly issue_events_url: string; /** - * Format: date - * @description The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format. + * @description A template for the API URL to get information about issues on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/issues{/number} */ - readonly date: string; - /** @description The total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint. */ - readonly total_active_users?: number; - /** @description The total number of Copilot users who engaged with any Copilot feature, for the given day. Examples include but are not limited to accepting a code suggestion, prompting Copilot chat, or triggering a PR Summary. Does not include authentication events. Is not limited to the individual features detailed on the endpoint. */ - readonly total_engaged_users?: number; - readonly copilot_ide_code_completions?: components["schemas"]["copilot-ide-code-completions"]; - readonly copilot_ide_chat?: components["schemas"]["copilot-ide-chat"]; - readonly copilot_dotcom_chat?: components["schemas"]["copilot-dotcom-chat"]; - readonly copilot_dotcom_pull_requests?: components["schemas"]["copilot-dotcom-pull-requests"]; - } & { - readonly [key: string]: unknown; + readonly issues_url: string; + /** + * @description A template for the API URL to get information about deploy keys on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + */ + readonly keys_url: string; + /** + * @description A template for the API URL to get information about labels of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/labels{/name} + */ + readonly labels_url: string; + /** + * Format: uri + * @description The API URL to get information about the languages of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/languages + */ + readonly languages_url: string; + /** + * Format: uri + * @description The API URL to merge branches in the repository. + * @example https://api.github.com/repos/octocat/Hello-World/merges + */ + readonly merges_url: string; + /** + * @description A template for the API URL to get information about milestones of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/milestones{/number} + */ + readonly milestones_url: string; + /** + * @description A template for the API URL to get information about notifications on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + */ + readonly notifications_url: string; + /** + * @description A template for the API URL to get information about pull requests on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/pulls{/number} + */ + readonly pulls_url: string; + /** + * @description A template for the API URL to get information about releases on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/releases{/id} + */ + readonly releases_url: string; + /** + * Format: uri + * @description The API URL to list the stargazers on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/stargazers + */ + readonly stargazers_url: string; + /** + * @description A template for the API URL to get information about statuses of a commit. + * @example https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + */ + readonly statuses_url: string; + /** + * Format: uri + * @description The API URL to list the subscribers on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/subscribers + */ + readonly subscribers_url: string; + /** + * Format: uri + * @description The API URL to subscribe to notifications for this repository. + * @example https://api.github.com/repos/octocat/Hello-World/subscription + */ + readonly subscription_url: string; + /** + * Format: uri + * @description The API URL to get information about tags on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/tags + */ + readonly tags_url: string; + /** + * Format: uri + * @description The API URL to list the teams on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/teams + */ + readonly teams_url: string; + /** + * @description A template for the API URL to create or retrieve a raw Git tree of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + */ + readonly trees_url: string; + /** + * Format: uri + * @description The API URL to list the hooks on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/hooks + */ + readonly hooks_url: string; }; - /** - * Copilot Usage Metrics - * @description Summary of Copilot usage. - */ - readonly "copilot-usage-metrics": { + /** @description Repositories associated with a code security configuration and attachment status */ + readonly "code-security-configuration-repositories": { /** - * Format: date - * @description The date for which the usage metrics are reported, in `YYYY-MM-DD` format. + * @description The attachment status of the code security configuration on the repository. + * @enum {string} */ - readonly day: string; - /** @description The total number of Copilot code completion suggestions shown to users. */ - readonly total_suggestions_count?: number; - /** @description The total number of Copilot code completion suggestions accepted by users. */ - readonly total_acceptances_count?: number; - /** @description The total number of lines of code completions suggested by Copilot. */ - readonly total_lines_suggested?: number; - /** @description The total number of lines of code completions accepted by users. */ - readonly total_lines_accepted?: number; - /** @description The total number of users who were shown Copilot code completion suggestions during the day specified. */ - readonly total_active_users?: number; - /** @description The total instances of users who accepted code suggested by Copilot Chat in the IDE (panel and inline). */ - readonly total_chat_acceptances?: number; - /** @description The total number of chat turns (prompt and response pairs) sent between users and Copilot Chat in the IDE. */ - readonly total_chat_turns?: number; - /** @description The total number of users who interacted with Copilot Chat in the IDE during the day specified. */ - readonly total_active_chat_users?: number; - /** @description Breakdown of Copilot code completions usage by language and editor */ - readonly breakdown: readonly ({ - /** @description The language in which Copilot suggestions were shown to users in the specified editor. */ - readonly language?: string; - /** @description The editor in which Copilot suggestions were shown to users for the specified language. */ - readonly editor?: string; - /** @description The number of Copilot suggestions shown to users in the editor specified during the day specified. */ - readonly suggestions_count?: number; - /** @description The number of Copilot suggestions accepted by users in the editor specified during the day specified. */ - readonly acceptances_count?: number; - /** @description The number of lines of code suggested by Copilot in the editor specified during the day specified. */ - readonly lines_suggested?: number; - /** @description The number of lines of code accepted by users in the editor specified during the day specified. */ - readonly lines_accepted?: number; - /** @description The number of users who were shown Copilot completion suggestions in the editor specified during the day specified. */ - readonly active_users?: number; - } & { - readonly [key: string]: unknown; - })[] | null; + readonly status?: "attached" | "attaching" | "detached" | "removed" | "enforced" | "failed" | "updating" | "removed_by_enterprise"; + readonly repository?: components["schemas"]["simple-repository"]; }; /** @description The security alert number. */ readonly "alert-number": number; @@ -20307,248 +20616,6 @@ export type components = { * @description The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ readonly "alert-auto-dismissed-at": string | null; - /** - * Simple Repository - * @description A GitHub repository. - */ - readonly "simple-repository": { - /** - * Format: int64 - * @description A unique identifier of the repository. - * @example 1296269 - */ - readonly id: number; - /** - * @description The GraphQL identifier of the repository. - * @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - */ - readonly node_id: string; - /** - * @description The name of the repository. - * @example Hello-World - */ - readonly name: string; - /** - * @description The full, globally unique, name of the repository. - * @example octocat/Hello-World - */ - readonly full_name: string; - readonly owner: components["schemas"]["simple-user"]; - /** @description Whether the repository is private. */ - readonly private: boolean; - /** - * Format: uri - * @description The URL to view the repository on GitHub.com. - * @example https://github.com/octocat/Hello-World - */ - readonly html_url: string; - /** - * @description The repository description. - * @example This your first repo! - */ - readonly description: string | null; - /** @description Whether the repository is a fork. */ - readonly fork: boolean; - /** - * Format: uri - * @description The URL to get more information about the repository from the GitHub API. - * @example https://api.github.com/repos/octocat/Hello-World - */ - readonly url: string; - /** - * @description A template for the API URL to download the repository as an archive. - * @example https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - */ - readonly archive_url: string; - /** - * @description A template for the API URL to list the available assignees for issues in the repository. - * @example https://api.github.com/repos/octocat/Hello-World/assignees{/user} - */ - readonly assignees_url: string; - /** - * @description A template for the API URL to create or retrieve a raw Git blob in the repository. - * @example https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - */ - readonly blobs_url: string; - /** - * @description A template for the API URL to get information about branches in the repository. - * @example https://api.github.com/repos/octocat/Hello-World/branches{/branch} - */ - readonly branches_url: string; - /** - * @description A template for the API URL to get information about collaborators of the repository. - * @example https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - */ - readonly collaborators_url: string; - /** - * @description A template for the API URL to get information about comments on the repository. - * @example https://api.github.com/repos/octocat/Hello-World/comments{/number} - */ - readonly comments_url: string; - /** - * @description A template for the API URL to get information about commits on the repository. - * @example https://api.github.com/repos/octocat/Hello-World/commits{/sha} - */ - readonly commits_url: string; - /** - * @description A template for the API URL to compare two commits or refs. - * @example https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - */ - readonly compare_url: string; - /** - * @description A template for the API URL to get the contents of the repository. - * @example https://api.github.com/repos/octocat/Hello-World/contents/{+path} - */ - readonly contents_url: string; - /** - * Format: uri - * @description A template for the API URL to list the contributors to the repository. - * @example https://api.github.com/repos/octocat/Hello-World/contributors - */ - readonly contributors_url: string; - /** - * Format: uri - * @description The API URL to list the deployments of the repository. - * @example https://api.github.com/repos/octocat/Hello-World/deployments - */ - readonly deployments_url: string; - /** - * Format: uri - * @description The API URL to list the downloads on the repository. - * @example https://api.github.com/repos/octocat/Hello-World/downloads - */ - readonly downloads_url: string; - /** - * Format: uri - * @description The API URL to list the events of the repository. - * @example https://api.github.com/repos/octocat/Hello-World/events - */ - readonly events_url: string; - /** - * Format: uri - * @description The API URL to list the forks of the repository. - * @example https://api.github.com/repos/octocat/Hello-World/forks - */ - readonly forks_url: string; - /** - * @description A template for the API URL to get information about Git commits of the repository. - * @example https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - */ - readonly git_commits_url: string; - /** - * @description A template for the API URL to get information about Git refs of the repository. - * @example https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - */ - readonly git_refs_url: string; - /** - * @description A template for the API URL to get information about Git tags of the repository. - * @example https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - */ - readonly git_tags_url: string; - /** - * @description A template for the API URL to get information about issue comments on the repository. - * @example https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - */ - readonly issue_comment_url: string; - /** - * @description A template for the API URL to get information about issue events on the repository. - * @example https://api.github.com/repos/octocat/Hello-World/issues/events{/number} - */ - readonly issue_events_url: string; - /** - * @description A template for the API URL to get information about issues on the repository. - * @example https://api.github.com/repos/octocat/Hello-World/issues{/number} - */ - readonly issues_url: string; - /** - * @description A template for the API URL to get information about deploy keys on the repository. - * @example https://api.github.com/repos/octocat/Hello-World/keys{/key_id} - */ - readonly keys_url: string; - /** - * @description A template for the API URL to get information about labels of the repository. - * @example https://api.github.com/repos/octocat/Hello-World/labels{/name} - */ - readonly labels_url: string; - /** - * Format: uri - * @description The API URL to get information about the languages of the repository. - * @example https://api.github.com/repos/octocat/Hello-World/languages - */ - readonly languages_url: string; - /** - * Format: uri - * @description The API URL to merge branches in the repository. - * @example https://api.github.com/repos/octocat/Hello-World/merges - */ - readonly merges_url: string; - /** - * @description A template for the API URL to get information about milestones of the repository. - * @example https://api.github.com/repos/octocat/Hello-World/milestones{/number} - */ - readonly milestones_url: string; - /** - * @description A template for the API URL to get information about notifications on the repository. - * @example https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - */ - readonly notifications_url: string; - /** - * @description A template for the API URL to get information about pull requests on the repository. - * @example https://api.github.com/repos/octocat/Hello-World/pulls{/number} - */ - readonly pulls_url: string; - /** - * @description A template for the API URL to get information about releases on the repository. - * @example https://api.github.com/repos/octocat/Hello-World/releases{/id} - */ - readonly releases_url: string; - /** - * Format: uri - * @description The API URL to list the stargazers on the repository. - * @example https://api.github.com/repos/octocat/Hello-World/stargazers - */ - readonly stargazers_url: string; - /** - * @description A template for the API URL to get information about statuses of a commit. - * @example https://api.github.com/repos/octocat/Hello-World/statuses/{sha} - */ - readonly statuses_url: string; - /** - * Format: uri - * @description The API URL to list the subscribers on the repository. - * @example https://api.github.com/repos/octocat/Hello-World/subscribers - */ - readonly subscribers_url: string; - /** - * Format: uri - * @description The API URL to subscribe to notifications for this repository. - * @example https://api.github.com/repos/octocat/Hello-World/subscription - */ - readonly subscription_url: string; - /** - * Format: uri - * @description The API URL to get information about tags on the repository. - * @example https://api.github.com/repos/octocat/Hello-World/tags - */ - readonly tags_url: string; - /** - * Format: uri - * @description The API URL to list the teams on the repository. - * @example https://api.github.com/repos/octocat/Hello-World/teams - */ - readonly teams_url: string; - /** - * @description A template for the API URL to create or retrieve a raw Git tree of the repository. - * @example https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - */ - readonly trees_url: string; - /** - * Format: uri - * @description The API URL to list the hooks on the repository. - * @example https://api.github.com/repos/octocat/Hello-World/hooks - */ - readonly hooks_url: string; - }; /** @description A Dependabot alert. */ readonly "dependabot-alert-with-repository": { readonly number: components["schemas"]["alert-number"]; @@ -20637,6 +20704,16 @@ export type components = { * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ readonly push_protection_bypassed_at?: string | null; + readonly push_protection_bypass_request_reviewer?: components["schemas"]["nullable-simple-user"]; + /** @description An optional comment when reviewing a push protection bypass. */ + readonly push_protection_bypass_request_reviewer_comment?: string | null; + /** @description An optional comment when requesting a push protection bypass. */ + readonly push_protection_bypass_request_comment?: string | null; + /** + * Format: uri + * @description The URL to a push protection bypass request. + */ + readonly push_protection_bypass_request_html_url?: string | null; /** @description The comment that was optionally added when this alert was closed */ readonly resolution_comment?: string | null; /** @@ -20836,6 +20913,12 @@ export type components = { readonly eyes: number; readonly rocket: number; }; + /** Sub-issues Summary */ + readonly "sub-issues-summary": { + readonly total: number; + readonly completed: number; + readonly percent_completed: number; + }; /** * Issue * @description Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. @@ -20938,6 +21021,7 @@ export type components = { readonly performed_via_github_app?: components["schemas"]["nullable-integration"]; readonly author_association: components["schemas"]["author-association"]; readonly reactions?: components["schemas"]["reaction-rollup"]; + readonly sub_issues_summary?: components["schemas"]["sub-issues-summary"]; }; /** * Issue Comment @@ -21624,6 +21708,10 @@ export type components = { readonly copilot?: readonly string[]; readonly packages?: readonly string[]; readonly actions?: readonly string[]; + readonly actions_inbound?: { + readonly full_domains?: readonly string[]; + readonly wildcard_domains?: readonly string[]; + }; readonly artifact_attestations?: { /** @example [ * "example" @@ -21967,6 +22055,32 @@ export type components = { /** @example A great organization */ readonly description: string | null; }; + readonly "billing-usage-report": { + readonly usageItems?: readonly { + /** @description Date of the usage line item. */ + readonly date: string; + /** @description Product name. */ + readonly product: string; + /** @description SKU name. */ + readonly sku: string; + /** @description Quantity of the usage line item. */ + readonly quantity: number; + /** @description Unit type of the usage line item. */ + readonly unitType: string; + /** @description Price per unit of the usage line item. */ + readonly pricePerUnit: number; + /** @description Gross amount of the usage line item. */ + readonly grossAmount: number; + /** @description Discount amount of the usage line item. */ + readonly discountAmount: number; + /** @description Net amount of the usage line item. */ + readonly netAmount: number; + /** @description Name of the organization. */ + readonly organizationName: string; + /** @description Name of the repository. */ + readonly repositoryName?: string; + }[]; + }; /** * Organization Full * @description Organization Full @@ -22588,135 +22702,6 @@ export type components = { readonly most_recent_instance: components["schemas"]["code-scanning-alert-instance"]; readonly repository: components["schemas"]["simple-repository"]; }; - /** @description A code security configuration */ - readonly "code-security-configuration": { - /** @description The ID of the code security configuration */ - readonly id?: number; - /** @description The name of the code security configuration. Must be unique within the organization. */ - readonly name?: string; - /** - * @description The type of the code security configuration. - * @enum {string} - */ - readonly target_type?: "global" | "organization" | "enterprise"; - /** @description A description of the code security configuration */ - readonly description?: string; - /** - * @description The enablement status of GitHub Advanced Security - * @enum {string} - */ - readonly advanced_security?: "enabled" | "disabled"; - /** - * @description The enablement status of Dependency Graph - * @enum {string} - */ - readonly dependency_graph?: "enabled" | "disabled" | "not_set"; - /** - * @description The enablement status of Automatic dependency submission - * @enum {string} - */ - readonly dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"; - /** @description Feature options for Automatic dependency submission */ - readonly dependency_graph_autosubmit_action_options?: { - /** @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. */ - readonly labeled_runners?: boolean; - }; - /** - * @description The enablement status of Dependabot alerts - * @enum {string} - */ - readonly dependabot_alerts?: "enabled" | "disabled" | "not_set"; - /** - * @description The enablement status of Dependabot security updates - * @enum {string} - */ - readonly dependabot_security_updates?: "enabled" | "disabled" | "not_set"; - /** - * @description The enablement status of code scanning default setup - * @enum {string} - */ - readonly code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; - /** - * @description The enablement status of secret scanning - * @enum {string} - */ - readonly secret_scanning?: "enabled" | "disabled" | "not_set"; - /** - * @description The enablement status of secret scanning push protection - * @enum {string} - */ - readonly secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; - /** - * @description The enablement status of secret scanning delegated bypass - * @enum {string} - */ - readonly secret_scanning_delegated_bypass?: "enabled" | "disabled" | "not_set"; - /** @description Feature options for secret scanning delegated bypass */ - readonly secret_scanning_delegated_bypass_options?: { - /** @description The bypass reviewers for secret scanning delegated bypass */ - readonly reviewers?: readonly { - /** @description The ID of the team or role selected as a bypass reviewer */ - readonly reviewer_id: number; - /** - * @description The type of the bypass reviewer - * @enum {string} - */ - readonly reviewer_type: "TEAM" | "ROLE"; - }[]; - }; - /** - * @description The enablement status of secret scanning validity checks - * @enum {string} - */ - readonly secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; - /** - * @description The enablement status of secret scanning non-provider patterns - * @enum {string} - */ - readonly secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set"; - /** - * @description The enablement status of private vulnerability reporting - * @enum {string} - */ - readonly private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; - /** - * @description The enforcement status for a security configuration - * @enum {string} - */ - readonly enforcement?: "enforced" | "unenforced"; - /** - * Format: uri - * @description The URL of the configuration - */ - readonly url?: string; - /** - * Format: uri - * @description The URL of the configuration - */ - readonly html_url?: string; - /** Format: date-time */ - readonly created_at?: string; - /** Format: date-time */ - readonly updated_at?: string; - }; - /** @description A list of default code security configurations */ - readonly "code-security-default-configurations": readonly { - /** - * @description The visibility of newly created repositories for which the code security configuration will be applied to by default - * @enum {unknown} - */ - readonly default_for_new_repos?: "public" | "private_and_internal" | "all"; - readonly configuration?: components["schemas"]["code-security-configuration"]; - }[]; - /** @description Repositories associated with a code security configuration and attachment status */ - readonly "code-security-configuration-repositories": { - /** - * @description The attachment status of the code security configuration on the repository. - * @enum {string} - */ - readonly status?: "attached" | "attaching" | "detached" | "removed" | "enforced" | "failed" | "updating" | "removed_by_enterprise"; - readonly repository?: components["schemas"]["simple-repository"]; - }; /** * Codespace machine * @description A description of the machine powering a codespace. @@ -23029,6 +23014,396 @@ export type components = { } & { readonly [key: string]: unknown; }; + /** + * Organization Simple + * @description A GitHub organization. + */ + readonly "nullable-organization-simple": { + /** @example github */ + readonly login: string; + /** @example 1 */ + readonly id: number; + /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ + readonly node_id: string; + /** + * Format: uri + * @example https://api.github.com/orgs/github + */ + readonly url: string; + /** + * Format: uri + * @example https://api.github.com/orgs/github/repos + */ + readonly repos_url: string; + /** + * Format: uri + * @example https://api.github.com/orgs/github/events + */ + readonly events_url: string; + /** @example https://api.github.com/orgs/github/hooks */ + readonly hooks_url: string; + /** @example https://api.github.com/orgs/github/issues */ + readonly issues_url: string; + /** @example https://api.github.com/orgs/github/members{/member} */ + readonly members_url: string; + /** @example https://api.github.com/orgs/github/public_members{/member} */ + readonly public_members_url: string; + /** @example https://github.com/images/error/octocat_happy.gif */ + readonly avatar_url: string; + /** @example A great organization */ + readonly description: string | null; + } | null; + /** + * Team Simple + * @description Groups of organization members that gives permissions on specified repositories. + */ + readonly "nullable-team-simple": { + /** + * @description Unique identifier of the team + * @example 1 + */ + readonly id: number; + /** @example MDQ6VGVhbTE= */ + readonly node_id: string; + /** + * Format: uri + * @description URL for the team + * @example https://api.github.com/organizations/1/team/1 + */ + readonly url: string; + /** @example https://api.github.com/organizations/1/team/1/members{/member} */ + readonly members_url: string; + /** + * @description Name of the team + * @example Justice League + */ + readonly name: string; + /** + * @description Description of the team + * @example A great team. + */ + readonly description: string | null; + /** + * @description Permission that the team will have for its repositories + * @example admin + */ + readonly permission: string; + /** + * @description The level of privacy this team should have + * @example closed + */ + readonly privacy?: string; + /** + * @description The notification setting the team has set + * @example notifications_enabled + */ + readonly notification_setting?: string; + /** + * Format: uri + * @example https://github.com/orgs/rails/teams/core + */ + readonly html_url: string; + /** + * Format: uri + * @example https://api.github.com/organizations/1/team/1/repos + */ + readonly repositories_url: string; + /** @example justice-league */ + readonly slug: string; + /** + * @description Distinguished Name (DN) that team maps to within LDAP environment + * @example uid=example,ou=users,dc=github,dc=com + */ + readonly ldap_dn?: string; + } | null; + /** + * Team + * @description Groups of organization members that gives permissions on specified repositories. + */ + readonly team: { + readonly id: number; + readonly node_id: string; + readonly name: string; + readonly slug: string; + readonly description: string | null; + readonly privacy?: string; + readonly notification_setting?: string; + readonly permission: string; + readonly permissions?: { + readonly pull: boolean; + readonly triage: boolean; + readonly push: boolean; + readonly maintain: boolean; + readonly admin: boolean; + }; + /** Format: uri */ + readonly url: string; + /** + * Format: uri + * @example https://github.com/orgs/rails/teams/core + */ + readonly html_url: string; + readonly members_url: string; + /** Format: uri */ + readonly repositories_url: string; + readonly parent: components["schemas"]["nullable-team-simple"]; + }; + /** + * Enterprise Team + * @description Group of enterprise owners and/or members + */ + readonly "enterprise-team": { + /** Format: int64 */ + readonly id: number; + readonly name: string; + readonly slug: string; + /** Format: uri */ + readonly url: string; + /** @example disabled | all */ + readonly sync_to_organizations: string; + /** @example 62ab9291-fae2-468e-974b-7e45096d5021 */ + readonly group_id?: string | null; + /** + * Format: uri + * @example https://github.com/enterprises/dc/teams/justice-league + */ + readonly html_url: string; + readonly members_url: string; + /** Format: date-time */ + readonly created_at: string; + /** Format: date-time */ + readonly updated_at: string; + }; + /** + * Copilot Business Seat Detail + * @description Information about a Copilot Business seat assignment for a user, team, or organization. + */ + readonly "copilot-seat-details": { + readonly assignee: components["schemas"]["simple-user"]; + readonly organization?: components["schemas"]["nullable-organization-simple"]; + /** @description The team through which the assignee is granted access to GitHub Copilot, if applicable. */ + readonly assigning_team?: (components["schemas"]["team"] | components["schemas"]["enterprise-team"]) | null; + /** + * Format: date + * @description The pending cancellation date for the seat, in `YYYY-MM-DD` format. This will be null unless the assignee's Copilot access has been canceled during the current billing cycle. If the seat has been cancelled, this corresponds to the start of the organization's next billing cycle. + */ + readonly pending_cancellation_date?: string | null; + /** + * Format: date-time + * @description Timestamp of user's last GitHub Copilot activity, in ISO 8601 format. + */ + readonly last_activity_at?: string | null; + /** @description Last editor that was used by the user for a GitHub Copilot completion. */ + readonly last_activity_editor?: string | null; + /** + * Format: date-time + * @description Timestamp of when the assignee was last granted access to GitHub Copilot, in ISO 8601 format. + */ + readonly created_at: string; + /** + * Format: date-time + * @deprecated + * @description **Closing down notice:** This field is no longer relevant and is closing down. Use the `created_at` field to determine when the assignee was last granted access to GitHub Copilot. Timestamp of when the assignee's GitHub Copilot access was last updated, in ISO 8601 format. + */ + readonly updated_at?: string; + /** + * @description The Copilot plan of the organization, or the parent enterprise, when applicable. + * @enum {string} + */ + readonly plan_type?: "business" | "enterprise" | "unknown"; + }; + /** @description Usage metrics for Copilot editor code completions in the IDE. */ + readonly "copilot-ide-code-completions": ({ + /** @description Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances. */ + readonly total_engaged_users?: number; + /** @description Code completion metrics for active languages. */ + readonly languages?: readonly { + /** @description Name of the language used for Copilot code completion suggestions. */ + readonly name?: string; + /** @description Number of users who accepted at least one Copilot code completion suggestion for the given language. Includes both full and partial acceptances. */ + readonly total_engaged_users?: number; + }[]; + readonly editors?: readonly ({ + /** @description Name of the given editor. */ + readonly name?: string; + /** @description Number of users who accepted at least one Copilot code completion suggestion for the given editor. Includes both full and partial acceptances. */ + readonly total_engaged_users?: number; + /** @description List of model metrics for custom models and the default model. */ + readonly models?: readonly { + /** @description Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'. */ + readonly name?: string; + /** @description Indicates whether a model is custom or default. */ + readonly is_custom_model?: boolean; + /** @description The training date for the custom model. */ + readonly custom_model_training_date?: string | null; + /** @description Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances. */ + readonly total_engaged_users?: number; + /** @description Code completion metrics for active languages, for the given editor. */ + readonly languages?: readonly { + /** @description Name of the language used for Copilot code completion suggestions, for the given editor. */ + readonly name?: string; + /** @description Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language. Includes both full and partial acceptances. */ + readonly total_engaged_users?: number; + /** @description The number of Copilot code suggestions generated for the given editor, for the given language. */ + readonly total_code_suggestions?: number; + /** @description The number of Copilot code suggestions accepted for the given editor, for the given language. Includes both full and partial acceptances. */ + readonly total_code_acceptances?: number; + /** @description The number of lines of code suggested by Copilot code completions for the given editor, for the given language. */ + readonly total_code_lines_suggested?: number; + /** @description The number of lines of code accepted from Copilot code suggestions for the given editor, for the given language. */ + readonly total_code_lines_accepted?: number; + }[]; + }[]; + } & { + readonly [key: string]: unknown; + })[]; + } & { + readonly [key: string]: unknown; + }) | null; + /** @description Usage metrics for Copilot Chat in the IDE. */ + readonly "copilot-ide-chat": ({ + /** @description Total number of users who prompted Copilot Chat in the IDE. */ + readonly total_engaged_users?: number; + readonly editors?: readonly { + /** @description Name of the given editor. */ + readonly name?: string; + /** @description The number of users who prompted Copilot Chat in the specified editor. */ + readonly total_engaged_users?: number; + /** @description List of model metrics for custom models and the default model. */ + readonly models?: readonly { + /** @description Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'. */ + readonly name?: string; + /** @description Indicates whether a model is custom or default. */ + readonly is_custom_model?: boolean; + /** @description The training date for the custom model. */ + readonly custom_model_training_date?: string | null; + /** @description The number of users who prompted Copilot Chat in the given editor and model. */ + readonly total_engaged_users?: number; + /** @description The total number of chats initiated by users in the given editor and model. */ + readonly total_chats?: number; + /** @description The number of times users accepted a code suggestion from Copilot Chat using the 'Insert Code' UI element, for the given editor. */ + readonly total_chat_insertion_events?: number; + /** @description The number of times users copied a code suggestion from Copilot Chat using the keyboard, or the 'Copy' UI element, for the given editor. */ + readonly total_chat_copy_events?: number; + }[]; + }[]; + } & { + readonly [key: string]: unknown; + }) | null; + /** @description Usage metrics for Copilot Chat in github.com */ + readonly "copilot-dotcom-chat": ({ + /** @description Total number of users who prompted Copilot Chat on github.com at least once. */ + readonly total_engaged_users?: number; + /** @description List of model metrics for a custom models and the default model. */ + readonly models?: readonly { + /** @description Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'. */ + readonly name?: string; + /** @description Indicates whether a model is custom or default. */ + readonly is_custom_model?: boolean; + /** @description The training date for the custom model (if applicable). */ + readonly custom_model_training_date?: string | null; + /** @description Total number of users who prompted Copilot Chat on github.com at least once for each model. */ + readonly total_engaged_users?: number; + /** @description Total number of chats initiated by users on github.com. */ + readonly total_chats?: number; + }[]; + } & { + readonly [key: string]: unknown; + }) | null; + /** @description Usage metrics for Copilot for pull requests. */ + readonly "copilot-dotcom-pull-requests": ({ + /** @description The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once. */ + readonly total_engaged_users?: number; + /** @description Repositories in which users used Copilot for Pull Requests to generate pull request summaries */ + readonly repositories?: readonly { + /** @description Repository name */ + readonly name?: string; + /** @description The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository. */ + readonly total_engaged_users?: number; + /** @description List of model metrics for custom models and the default model. */ + readonly models?: readonly { + /** @description Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'. */ + readonly name?: string; + /** @description Indicates whether a model is custom or default. */ + readonly is_custom_model?: boolean; + /** @description The training date for the custom model. */ + readonly custom_model_training_date?: string | null; + /** @description The number of pull request summaries generated using Copilot for Pull Requests in the given repository. */ + readonly total_pr_summaries_created?: number; + /** @description The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository and model. */ + readonly total_engaged_users?: number; + }[]; + }[]; + } & { + readonly [key: string]: unknown; + }) | null; + /** + * Copilot Usage Metrics + * @description Copilot usage metrics for a given day. + */ + readonly "copilot-usage-metrics-day": { + /** + * Format: date + * @description The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format. + */ + readonly date: string; + /** @description The total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint. */ + readonly total_active_users?: number; + /** @description The total number of Copilot users who engaged with any Copilot feature, for the given day. Examples include but are not limited to accepting a code suggestion, prompting Copilot chat, or triggering a PR Summary. Does not include authentication events. Is not limited to the individual features detailed on the endpoint. */ + readonly total_engaged_users?: number; + readonly copilot_ide_code_completions?: components["schemas"]["copilot-ide-code-completions"]; + readonly copilot_ide_chat?: components["schemas"]["copilot-ide-chat"]; + readonly copilot_dotcom_chat?: components["schemas"]["copilot-dotcom-chat"]; + readonly copilot_dotcom_pull_requests?: components["schemas"]["copilot-dotcom-pull-requests"]; + } & { + readonly [key: string]: unknown; + }; + /** + * Copilot Usage Metrics + * @description Summary of Copilot usage. + */ + readonly "copilot-usage-metrics": { + /** + * Format: date + * @description The date for which the usage metrics are reported, in `YYYY-MM-DD` format. + */ + readonly day: string; + /** @description The total number of Copilot code completion suggestions shown to users. */ + readonly total_suggestions_count?: number; + /** @description The total number of Copilot code completion suggestions accepted by users. */ + readonly total_acceptances_count?: number; + /** @description The total number of lines of code completions suggested by Copilot. */ + readonly total_lines_suggested?: number; + /** @description The total number of lines of code completions accepted by users. */ + readonly total_lines_accepted?: number; + /** @description The total number of users who were shown Copilot code completion suggestions during the day specified. */ + readonly total_active_users?: number; + /** @description The total instances of users who accepted code suggested by Copilot Chat in the IDE (panel and inline). */ + readonly total_chat_acceptances?: number; + /** @description The total number of chat turns (prompt and response pairs) sent between users and Copilot Chat in the IDE. */ + readonly total_chat_turns?: number; + /** @description The total number of users who interacted with Copilot Chat in the IDE during the day specified. */ + readonly total_active_chat_users?: number; + /** @description Breakdown of Copilot code completions usage by language and editor */ + readonly breakdown: readonly ({ + /** @description The language in which Copilot suggestions were shown to users in the specified editor. */ + readonly language?: string; + /** @description The editor in which Copilot suggestions were shown to users for the specified language. */ + readonly editor?: string; + /** @description The number of Copilot suggestions shown to users in the editor specified during the day specified. */ + readonly suggestions_count?: number; + /** @description The number of Copilot suggestions accepted by users in the editor specified during the day specified. */ + readonly acceptances_count?: number; + /** @description The number of lines of code suggested by Copilot in the editor specified during the day specified. */ + readonly lines_suggested?: number; + /** @description The number of lines of code accepted by users in the editor specified during the day specified. */ + readonly lines_accepted?: number; + /** @description The number of users who were shown Copilot completion suggestions in the editor specified during the day specified. */ + readonly active_users?: number; + } & { + readonly [key: string]: unknown; + })[] | null; + }; /** * Dependabot Secret for an Organization * @description Secrets for GitHub Dependabot for an organization. @@ -23608,6 +23983,16 @@ export type components = { readonly name: string; /** @description A short description about who this role is for or what permissions it grants. */ readonly description?: string | null; + /** + * @description The system role from which this role inherits permissions. + * @enum {string|null} + */ + readonly base_role?: "read" | "triage" | "write" | "maintain" | "admin" | null; + /** + * @description Source answers the question, "where did this role come from?" + * @enum {string|null} + */ + readonly source?: "Organization" | "Enterprise" | "Predefined" | null; /** @description A list of permissions included in this role. */ readonly permissions: readonly string[]; readonly organization: components["schemas"]["nullable-simple-user"]; @@ -23627,6 +24012,12 @@ export type components = { * @description The Relationship a Team has with a role. */ readonly "team-role-assignment": { + /** + * @description Determines if the team has a direct, indirect, or mixed relationship to a role + * @example direct + * @enum {string} + */ + readonly assignment?: "direct" | "indirect" | "mixed"; readonly id: number; readonly node_id: string; readonly name: string; @@ -23722,6 +24113,14 @@ export type components = { * @description The Relationship a User has with a role. */ readonly "user-role-assignment": { + /** + * @description Determines if the user has a direct, indirect, or mixed relationship to a role + * @example direct + * @enum {string} + */ + readonly assignment?: "direct" | "indirect" | "mixed"; + /** @description Team the user has gotten the role through */ + readonly inherited_from?: readonly components["schemas"]["team-simple"][]; readonly name?: string | null; readonly email?: string | null; /** @example octocat */ @@ -23926,6 +24325,68 @@ export type components = { /** @description Date and time when the associated fine-grained personal access token was last used for authentication. */ readonly token_last_used_at: string | null; }; + /** + * Organization private registry + * @description Private registry configuration for an organization + */ + readonly "org-private-registry-configuration": { + /** + * @description The name of the private registry configuration. + * @example MAVEN_REPOSITORY_SECRET + */ + readonly name: string; + /** + * @description The registry type. + * @enum {string} + */ + readonly registry_type: "maven_repository"; + /** + * @description The username to use when authenticating with the private registry. + * @example monalisa + */ + readonly username?: string | null; + /** + * @description Which type of organization repositories have access to the private registry. + * @enum {string} + */ + readonly visibility: "all" | "private" | "selected"; + /** Format: date-time */ + readonly created_at: string; + /** Format: date-time */ + readonly updated_at: string; + }; + /** + * Organization private registry + * @description Private registry configuration for an organization + */ + readonly "org-private-registry-configuration-with-selected-repositories": { + /** + * @description The name of the private registry configuration. + * @example MAVEN_REPOSITORY_SECRET + */ + readonly name: string; + /** + * @description The registry type. + * @enum {string} + */ + readonly registry_type: "maven_repository"; + /** + * @description The username to use when authenticating with the private registry. + * @example monalisa + */ + readonly username?: string; + /** + * @description Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry. + * @enum {string} + */ + readonly visibility: "all" | "private" | "selected"; + /** @description An array of repository IDs that can access the organization private registry when `visibility` is set to `selected`. */ + readonly selected_repository_ids?: readonly number[]; + /** Format: date-time */ + readonly created_at: string; + /** Format: date-time */ + readonly updated_at: string; + }; /** * Project * @description Projects are a way to organize columns and cards of work. @@ -24003,6 +24464,12 @@ export type components = { * @description The URL that can be used to fetch, update, or delete info about this property via the API. */ readonly url?: string; + /** + * @description The source type of the property + * @example organization + * @enum {string} + */ + readonly source_type?: "organization" | "enterprise"; /** * @description The type of the value for the property * @example single_select @@ -24025,6 +24492,27 @@ export type components = { */ readonly values_editable_by?: "org_actors" | "org_and_repo_actors" | null; }; + /** + * Custom Property Set Payload + * @description Custom property set payload + */ + readonly "custom-property-set-payload": { + /** + * @description The type of the value for the property + * @example single_select + * @enum {string} + */ + readonly value_type: "string" | "single_select" | "multi_select" | "true_false"; + /** @description Whether the property is required. */ + readonly required?: boolean; + /** @description Default value of the property */ + readonly default_value?: (string | readonly string[]) | null; + /** @description Short description of the property */ + readonly description?: string | null; + /** @description An ordered list of the allowed values of the property. + * The property can have up to 200 allowed values. */ + readonly allowed_values?: readonly string[] | null; + }; /** * Custom Property Value * @description Custom property name and associated value @@ -24829,6 +25317,7 @@ export type components = { * @description Conditions for an organization ruleset. * The branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties. * The push rulesets conditions object does not require the `ref_name` property. + * For repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`. */ readonly "org-ruleset-conditions": (components["schemas"]["repository-ruleset-conditions"] & components["schemas"]["repository-ruleset-conditions-repository-name-target"]) | (components["schemas"]["repository-ruleset-conditions"] & components["schemas"]["repository-ruleset-conditions-repository-id-target"]) | (components["schemas"]["repository-ruleset-conditions"] & components["schemas"]["repository-ruleset-conditions-repository-property-target"]); /** @@ -24937,6 +25426,8 @@ export type components = { /** @enum {string} */ readonly type: "pull_request"; readonly parameters?: { + /** @description When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled. */ + readonly allowed_merge_methods?: readonly string[]; /** @description New, reviewable commits pushed will dismiss previous pull request review approvals. */ readonly dismiss_stale_reviews_on_push: boolean; /** @description Require an approving review in pull requests that modify files that have a designated code owner. */ @@ -25202,12 +25693,12 @@ export type components = { * @description The target of the ruleset * @enum {string} */ - readonly target?: "branch" | "tag" | "push"; + readonly target?: "branch" | "tag" | "push" | "repository"; /** * @description The type of the source of the ruleset * @enum {string} */ - readonly source_type?: "Repository" | "Organization"; + readonly source_type?: "Repository" | "Organization" | "Enterprise"; /** @description The name of the source */ readonly source: string; readonly enforcement: components["schemas"]["repository-rule-enforcement"]; @@ -26361,6 +26852,7 @@ export type components = { readonly actions_runner_registration?: components["schemas"]["rate-limit"]; readonly scim?: components["schemas"]["rate-limit"]; readonly dependency_snapshots?: components["schemas"]["rate-limit"]; + readonly code_scanning_autofix?: components["schemas"]["rate-limit"]; }; readonly rate: components["schemas"]["rate-limit"]; }; @@ -27498,6 +27990,7 @@ export type components = { readonly reason: string; readonly payload: string | null; readonly signature: string | null; + readonly verified_at?: string | null; }; /** * Diff Entry @@ -28069,6 +28562,36 @@ export type components = { * @enum {string} */ readonly "code-scanning-alert-set-state": "open" | "dismissed"; + /** + * @description The status of an autofix. + * @enum {string} + */ + readonly "code-scanning-autofix-status": "pending" | "error" | "success" | "outdated"; + /** @description The description of an autofix. */ + readonly "code-scanning-autofix-description": string | null; + /** + * Format: date-time + * @description The start time of an autofix in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + readonly "code-scanning-autofix-started-at": string; + readonly "code-scanning-autofix": { + readonly status: components["schemas"]["code-scanning-autofix-status"]; + readonly description: components["schemas"]["code-scanning-autofix-description"]; + readonly started_at: components["schemas"]["code-scanning-autofix-started-at"]; + }; + /** @description Commit an autofix for a code scanning alert */ + readonly "code-scanning-autofix-commits": { + /** @description The Git reference of target branch for the commit. Branch needs to already exist. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ + readonly target_ref?: string; + /** @description Commit message to be used. */ + readonly message?: string; + } | null; + readonly "code-scanning-autofix-commits-response": { + /** @description The Git reference of target branch for the commit. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ + readonly target_ref?: string; + /** @description SHA of commit with autofix. */ + readonly sha?: string; + }; /** * @description An identifier for the upload. * @example 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53 @@ -28298,7 +28821,7 @@ export type components = { */ readonly state?: "configured" | "not-configured"; /** @description Languages to be analyzed. */ - readonly languages?: readonly ("c-cpp" | "csharp" | "go" | "java-kotlin" | "javascript-typescript" | "javascript" | "python" | "ruby" | "typescript" | "swift")[]; + readonly languages?: readonly ("actions" | "c-cpp" | "csharp" | "go" | "java-kotlin" | "javascript-typescript" | "javascript" | "python" | "ruby" | "typescript" | "swift")[]; /** * @description CodeQL query suite to be used. * @enum {string} @@ -28323,13 +28846,23 @@ export type components = { * @enum {string} */ readonly state?: "configured" | "not-configured"; + /** + * @description Runner type to be used. + * @enum {string} + */ + readonly runner_type?: "standard" | "labeled"; + /** + * @description Runner label to be used if the runner type is labeled. + * @example code-scanning + */ + readonly runner_label?: string | null; /** * @description CodeQL query suite to be used. * @enum {string} */ readonly query_suite?: "default" | "extended"; /** @description CodeQL languages to be analyzed. */ - readonly languages?: readonly ("c-cpp" | "csharp" | "go" | "java-kotlin" | "javascript-typescript" | "python" | "ruby" | "swift")[]; + readonly languages?: readonly ("actions" | "c-cpp" | "csharp" | "go" | "java-kotlin" | "javascript-typescript" | "python" | "ruby" | "swift")[]; }; /** @description You can use `run_url` to track the status of the run. This includes a property status and conclusion. * You should not rely on this always being an actions workflow run object. */ @@ -29285,6 +29818,7 @@ export type components = { readonly reason?: string; readonly signature?: string | null; readonly payload?: string | null; + readonly verified_at?: string | null; }; }; }; @@ -30039,6 +30573,7 @@ export type components = { readonly reason: string; readonly signature: string | null; readonly payload: string | null; + readonly verified_at?: string | null; }; /** Format: uri */ readonly html_url: string; @@ -30400,6 +30935,7 @@ export type components = { readonly performed_via_github_app?: components["schemas"]["nullable-integration"]; readonly author_association: components["schemas"]["author-association"]; readonly reactions?: components["schemas"]["reaction-rollup"]; + readonly sub_issues_summary?: components["schemas"]["sub-issues-summary"]; } | null; /** * Issue Event Label @@ -30978,6 +31514,7 @@ export type components = { readonly reason: string; readonly signature: string | null; readonly payload: string | null; + readonly verified_at?: string | null; }; /** Format: uri */ readonly html_url: string; @@ -32114,6 +32651,16 @@ export type components = { * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ readonly push_protection_bypassed_at?: string | null; + readonly push_protection_bypass_request_reviewer?: components["schemas"]["nullable-simple-user"]; + /** @description An optional comment when reviewing a push protection bypass. */ + readonly push_protection_bypass_request_reviewer_comment?: string | null; + /** @description An optional comment when requesting a push protection bypass. */ + readonly push_protection_bypass_request_comment?: string | null; + /** + * Format: uri + * @description The URL to a push protection bypass request. + */ + readonly push_protection_bypass_request_html_url?: string | null; /** * @description The token status as of the latest validity check. * @enum {string} @@ -32251,7 +32798,7 @@ export type components = { /** * Format: uri * @description The API URL to get the pull request where the secret was detected. - * @example https://api.github.com/repos/octocat/Hello-World/pull/2846 + * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846 */ readonly pull_request_title_url: string; }; @@ -32260,7 +32807,7 @@ export type components = { /** * Format: uri * @description The API URL to get the pull request where the secret was detected. - * @example https://api.github.com/repos/octocat/Hello-World/pull/2846 + * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846 */ readonly pull_request_body_url: string; }; @@ -32315,6 +32862,34 @@ export type components = { /** @description The token type this bypass is for. */ readonly token_type?: string; }; + /** @description Information on a single scan performed by secret scanning on the repository */ + readonly "secret-scanning-scan": { + /** @description The type of scan */ + readonly type?: string; + /** @description The state of the scan. Either "completed", "running", or "pending" */ + readonly status?: string; + /** + * Format: date-time + * @description The time that the scan was completed. Empty if the scan is running + */ + readonly completed_at?: string | null; + /** + * Format: date-time + * @description The time that the scan was started. Empty if the scan is pending + */ + readonly started_at?: string | null; + }; + readonly "secret-scanning-scan-history": { + readonly incremental_scans?: readonly components["schemas"]["secret-scanning-scan"][]; + readonly pattern_update_scans?: readonly components["schemas"]["secret-scanning-scan"][]; + readonly backfill_scans?: readonly components["schemas"]["secret-scanning-scan"][]; + readonly custom_pattern_backfill_scans?: readonly (components["schemas"]["secret-scanning-scan"] & { + /** @description Name of the custom pattern for custom pattern scans */ + readonly pattern_name?: string; + /** @description Level at which the custom pattern is defined, one of "repository", "organization", or "enterprise" */ + readonly pattern_scope?: string; + })[]; + }; readonly "repository-advisory-create": { /** @description A short summary of the advisory. */ readonly summary: string; @@ -32749,6 +33324,12 @@ export type components = { readonly default?: boolean; readonly description?: string | null; }[]; + /** Sub-issues Summary */ + readonly sub_issues_summary?: { + readonly total: number; + readonly completed: number; + readonly percent_completed: number; + }; readonly state: string; readonly state_reason?: string | null; readonly assignee: components["schemas"]["nullable-simple-user"]; @@ -35340,6 +35921,12 @@ export type components = { }; /** Format: uri */ readonly repository_url: string; + /** Sub-issues Summary */ + readonly sub_issues_summary?: { + readonly total: number; + readonly completed: number; + readonly percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -35828,6 +36415,12 @@ export type components = { }; /** Format: uri */ readonly repository_url: string; + /** Sub-issues Summary */ + readonly sub_issues_summary?: { + readonly total: number; + readonly completed: number; + readonly percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -38908,6 +39501,16 @@ export type components = { * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ readonly push_protection_bypassed_at?: string | null; + readonly push_protection_bypass_request_reviewer?: components["schemas"]["nullable-simple-user"]; + /** @description An optional comment when reviewing a push protection bypass. */ + readonly push_protection_bypass_request_reviewer_comment?: string | null; + /** @description An optional comment when requesting a push protection bypass. */ + readonly push_protection_bypass_request_comment?: string | null; + /** + * Format: uri + * @description The URL to a push protection bypass request. + */ + readonly push_protection_bypass_request_html_url?: string | null; /** @description Whether the detected secret was publicly leaked. */ readonly publicly_leaked?: boolean | null; /** @description Whether the detected secret was found in multiple repositories in the same organization or business. */ @@ -43992,21 +44595,424 @@ export type components = { * @enum {string} */ readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue comment */ - readonly body: string; + /** @description Contents of the issue comment */ + readonly body: string; + /** Format: date-time */ + readonly created_at: string; + /** Format: uri */ + readonly html_url: string; + /** + * Format: int64 + * @description Unique identifier of the issue comment + */ + readonly id: number; + /** Format: uri */ + readonly issue_url: string; + readonly node_id: string; + readonly performed_via_github_app: components["schemas"]["nullable-integration"]; + /** Reactions */ + readonly reactions: { + readonly "+1": number; + readonly "-1": number; + readonly confused: number; + readonly eyes: number; + readonly heart: number; + readonly hooray: number; + readonly laugh: number; + readonly rocket: number; + readonly total_count: number; + /** Format: uri */ + readonly url: string; + }; + /** Format: date-time */ + readonly updated_at: string; + /** + * Format: uri + * @description URL for the issue comment + */ + readonly url: string; + /** User */ + readonly user: { + /** Format: uri */ + readonly avatar_url?: string; + readonly deleted?: boolean; + readonly email?: string | null; + /** Format: uri-template */ + readonly events_url?: string; + /** Format: uri */ + readonly followers_url?: string; + /** Format: uri-template */ + readonly following_url?: string; + /** Format: uri-template */ + readonly gists_url?: string; + readonly gravatar_id?: string; + /** Format: uri */ + readonly html_url?: string; + /** Format: int64 */ + readonly id: number; + readonly login: string; + readonly name?: string; + readonly node_id?: string; + /** Format: uri */ + readonly organizations_url?: string; + /** Format: uri */ + readonly received_events_url?: string; + /** Format: uri */ + readonly repos_url?: string; + readonly site_admin?: boolean; + /** Format: uri-template */ + readonly starred_url?: string; + /** Format: uri */ + readonly subscriptions_url?: string; + /** @enum {string} */ + readonly type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + readonly url?: string; + readonly user_view_type?: string; + } | null; + }; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. */ + readonly issue: { + /** @enum {string|null} */ + readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + /** User */ + readonly assignee?: { + /** Format: uri */ + readonly avatar_url?: string; + readonly deleted?: boolean; + readonly email?: string | null; + /** Format: uri-template */ + readonly events_url?: string; + /** Format: uri */ + readonly followers_url?: string; + /** Format: uri-template */ + readonly following_url?: string; + /** Format: uri-template */ + readonly gists_url?: string; + readonly gravatar_id?: string; + /** Format: uri */ + readonly html_url?: string; + readonly id: number; + readonly login: string; + readonly name?: string; + readonly node_id?: string; + /** Format: uri */ + readonly organizations_url?: string; + /** Format: uri */ + readonly received_events_url?: string; + /** Format: uri */ + readonly repos_url?: string; + readonly site_admin?: boolean; + /** Format: uri-template */ + readonly starred_url?: string; + /** Format: uri */ + readonly subscriptions_url?: string; + /** @enum {string} */ + readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + /** Format: uri */ + readonly url?: string; + readonly user_view_type?: string; + } | null; + readonly assignees: readonly ({ + /** Format: uri */ + readonly avatar_url?: string; + readonly deleted?: boolean; + readonly email?: string | null; + /** Format: uri-template */ + readonly events_url?: string; + /** Format: uri */ + readonly followers_url?: string; + /** Format: uri-template */ + readonly following_url?: string; + /** Format: uri-template */ + readonly gists_url?: string; + readonly gravatar_id?: string; + /** Format: uri */ + readonly html_url?: string; + readonly id: number; + readonly login: string; + readonly name?: string; + readonly node_id?: string; + /** Format: uri */ + readonly organizations_url?: string; + /** Format: uri */ + readonly received_events_url?: string; + /** Format: uri */ + readonly repos_url?: string; + readonly site_admin?: boolean; + /** Format: uri-template */ + readonly starred_url?: string; + /** Format: uri */ + readonly subscriptions_url?: string; + /** @enum {string} */ + readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + /** Format: uri */ + readonly url?: string; + readonly user_view_type?: string; + } | null)[]; + /** + * AuthorAssociation + * @description How the author is associated with the repository. + * @enum {string} + */ + readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + /** @description Contents of the issue */ + readonly body: string | null; + /** Format: date-time */ + readonly closed_at: string | null; + readonly comments: number; + /** Format: uri */ + readonly comments_url: string; /** Format: date-time */ readonly created_at: string; + readonly draft?: boolean; + /** Format: uri */ + readonly events_url: string; /** Format: uri */ readonly html_url: string; + /** Format: int64 */ + readonly id: number; + readonly labels?: readonly { + /** @description 6-character hex code, without the leading #, identifying the color */ + readonly color: string; + readonly default: boolean; + readonly description: string | null; + readonly id: number; + /** @description The name of the label. */ + readonly name: string; + readonly node_id: string; + /** + * Format: uri + * @description URL for the label + */ + readonly url: string; + }[]; + /** Format: uri-template */ + readonly labels_url: string; + readonly locked?: boolean; /** - * Format: int64 - * @description Unique identifier of the issue comment + * Milestone + * @description A collection of related issues and pull requests. */ - readonly id: number; - /** Format: uri */ - readonly issue_url: string; + readonly milestone: { + /** Format: date-time */ + readonly closed_at: string | null; + readonly closed_issues: number; + /** Format: date-time */ + readonly created_at: string; + /** User */ + readonly creator: { + /** Format: uri */ + readonly avatar_url?: string; + readonly deleted?: boolean; + readonly email?: string | null; + /** Format: uri-template */ + readonly events_url?: string; + /** Format: uri */ + readonly followers_url?: string; + /** Format: uri-template */ + readonly following_url?: string; + /** Format: uri-template */ + readonly gists_url?: string; + readonly gravatar_id?: string; + /** Format: uri */ + readonly html_url?: string; + readonly id: number; + readonly login: string; + readonly name?: string; + readonly node_id?: string; + /** Format: uri */ + readonly organizations_url?: string; + /** Format: uri */ + readonly received_events_url?: string; + /** Format: uri */ + readonly repos_url?: string; + readonly site_admin?: boolean; + /** Format: uri-template */ + readonly starred_url?: string; + /** Format: uri */ + readonly subscriptions_url?: string; + /** @enum {string} */ + readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + /** Format: uri */ + readonly url?: string; + readonly user_view_type?: string; + } | null; + readonly description: string | null; + /** Format: date-time */ + readonly due_on: string | null; + /** Format: uri */ + readonly html_url: string; + readonly id: number; + /** Format: uri */ + readonly labels_url: string; + readonly node_id: string; + /** @description The number of the milestone. */ + readonly number: number; + readonly open_issues: number; + /** + * @description The state of the milestone. + * @enum {string} + */ + readonly state: "open" | "closed"; + /** @description The title of the milestone. */ + readonly title: string; + /** Format: date-time */ + readonly updated_at: string; + /** Format: uri */ + readonly url: string; + } | null; readonly node_id: string; - readonly performed_via_github_app: components["schemas"]["nullable-integration"]; + readonly number: number; + /** + * App + * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. + */ + readonly performed_via_github_app?: { + /** Format: date-time */ + readonly created_at: string | null; + readonly description: string | null; + /** @description The list of events for the GitHub app */ + readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "pull_request_review_thread")[]; + /** Format: uri */ + readonly external_url: string | null; + /** Format: uri */ + readonly html_url: string; + /** @description Unique identifier of the GitHub app */ + readonly id: number | null; + /** @description The name of the GitHub app */ + readonly name: string; + readonly node_id: string; + /** User */ + readonly owner: { + /** Format: uri */ + readonly avatar_url?: string; + readonly deleted?: boolean; + readonly email?: string | null; + /** Format: uri-template */ + readonly events_url?: string; + /** Format: uri */ + readonly followers_url?: string; + /** Format: uri-template */ + readonly following_url?: string; + /** Format: uri-template */ + readonly gists_url?: string; + readonly gravatar_id?: string; + /** Format: uri */ + readonly html_url?: string; + readonly id: number; + readonly login: string; + readonly name?: string; + readonly node_id?: string; + /** Format: uri */ + readonly organizations_url?: string; + /** Format: uri */ + readonly received_events_url?: string; + /** Format: uri */ + readonly repos_url?: string; + readonly site_admin?: boolean; + /** Format: uri-template */ + readonly starred_url?: string; + /** Format: uri */ + readonly subscriptions_url?: string; + /** @enum {string} */ + readonly type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + readonly url?: string; + readonly user_view_type?: string; + } | null; + /** @description The set of permissions for the GitHub app */ + readonly permissions?: { + /** @enum {string} */ + readonly actions?: "read" | "write"; + /** @enum {string} */ + readonly administration?: "read" | "write"; + /** @enum {string} */ + readonly checks?: "read" | "write"; + /** @enum {string} */ + readonly content_references?: "read" | "write"; + /** @enum {string} */ + readonly contents?: "read" | "write"; + /** @enum {string} */ + readonly deployments?: "read" | "write"; + /** @enum {string} */ + readonly discussions?: "read" | "write"; + /** @enum {string} */ + readonly emails?: "read" | "write"; + /** @enum {string} */ + readonly environments?: "read" | "write"; + /** @enum {string} */ + readonly issues?: "read" | "write"; + /** @enum {string} */ + readonly keys?: "read" | "write"; + /** @enum {string} */ + readonly members?: "read" | "write"; + /** @enum {string} */ + readonly metadata?: "read" | "write"; + /** @enum {string} */ + readonly organization_administration?: "read" | "write"; + /** @enum {string} */ + readonly organization_hooks?: "read" | "write"; + /** @enum {string} */ + readonly organization_packages?: "read" | "write"; + /** @enum {string} */ + readonly organization_plan?: "read" | "write"; + /** @enum {string} */ + readonly organization_projects?: "read" | "write" | "admin"; + /** @enum {string} */ + readonly organization_secrets?: "read" | "write"; + /** @enum {string} */ + readonly organization_self_hosted_runners?: "read" | "write"; + /** @enum {string} */ + readonly organization_user_blocking?: "read" | "write"; + /** @enum {string} */ + readonly packages?: "read" | "write"; + /** @enum {string} */ + readonly pages?: "read" | "write"; + /** @enum {string} */ + readonly pull_requests?: "read" | "write"; + /** @enum {string} */ + readonly repository_hooks?: "read" | "write"; + /** @enum {string} */ + readonly repository_projects?: "read" | "write" | "admin"; + /** @enum {string} */ + readonly secret_scanning_alerts?: "read" | "write"; + /** @enum {string} */ + readonly secrets?: "read" | "write"; + /** @enum {string} */ + readonly security_events?: "read" | "write"; + /** @enum {string} */ + readonly security_scanning_alert?: "read" | "write"; + /** @enum {string} */ + readonly single_file?: "read" | "write"; + /** @enum {string} */ + readonly statuses?: "read" | "write"; + /** @enum {string} */ + readonly team_discussions?: "read" | "write"; + /** @enum {string} */ + readonly vulnerability_alerts?: "read" | "write"; + /** @enum {string} */ + readonly workflows?: "read" | "write"; + }; + /** @description The slug name of the GitHub app */ + readonly slug?: string; + /** Format: date-time */ + readonly updated_at: string | null; + } | null; + readonly pull_request?: { + /** Format: uri */ + readonly diff_url?: string; + /** Format: uri */ + readonly html_url?: string; + /** Format: date-time */ + readonly merged_at?: string | null; + /** Format: uri */ + readonly patch_url?: string; + /** Format: uri */ + readonly url?: string; + }; /** Reactions */ readonly reactions: { readonly "+1": number; @@ -44021,11 +45027,29 @@ export type components = { /** Format: uri */ readonly url: string; }; + /** Format: uri */ + readonly repository_url: string; + /** Sub-issues Summary */ + readonly sub_issues_summary?: { + readonly total: number; + readonly completed: number; + readonly percent_completed: number; + }; + /** + * @description State of the issue; either 'open' or 'closed' + * @enum {string} + */ + readonly state?: "open" | "closed"; + readonly state_reason?: string | null; + /** Format: uri */ + readonly timeline_url?: string; + /** @description Title of the issue */ + readonly title: string; /** Format: date-time */ readonly updated_at: string; /** * Format: uri - * @description URL for the issue comment + * @description URL for the issue */ readonly url: string; /** User */ @@ -44062,12 +45086,135 @@ export type components = { /** Format: uri */ readonly subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + /** Format: uri */ + readonly url?: string; + readonly user_view_type?: string; + } | null; + } & { + readonly active_lock_reason?: string | null; + /** User */ + readonly assignee: { + /** Format: uri */ + readonly avatar_url?: string; + readonly deleted?: boolean; + readonly email?: string | null; + /** Format: uri-template */ + readonly events_url?: string; + /** Format: uri */ + readonly followers_url?: string; + /** Format: uri-template */ + readonly following_url?: string; + /** Format: uri-template */ + readonly gists_url?: string; + readonly gravatar_id?: string; + /** Format: uri */ + readonly html_url?: string; + readonly id: number; + readonly login: string; + readonly name?: string; + readonly node_id?: string; + /** Format: uri */ + readonly organizations_url?: string; + /** Format: uri */ + readonly received_events_url?: string; + /** Format: uri */ + readonly repos_url?: string; + readonly site_admin?: boolean; + /** Format: uri-template */ + readonly starred_url?: string; + /** Format: uri */ + readonly subscriptions_url?: string; + /** @enum {string} */ + readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; readonly user_view_type?: string; } | null; + readonly assignees?: readonly Record[]; + readonly author_association?: string; + readonly body?: string | null; + readonly closed_at?: string | null; + readonly comments?: number; + readonly comments_url?: string; + readonly created_at?: string; + readonly events_url?: string; + readonly html_url?: string; + readonly id?: number; + readonly labels: readonly { + /** @description 6-character hex code, without the leading #, identifying the color */ + readonly color: string; + readonly default: boolean; + readonly description: string | null; + readonly id: number; + /** @description The name of the label. */ + readonly name: string; + readonly node_id: string; + /** + * Format: uri + * @description URL for the label + */ + readonly url: string; + }[]; + readonly labels_url?: string; + readonly locked: boolean; + readonly milestone?: Record; + readonly node_id?: string; + readonly number?: number; + readonly performed_via_github_app?: Record; + readonly reactions?: { + readonly "+1"?: number; + readonly "-1"?: number; + readonly confused?: number; + readonly eyes?: number; + readonly heart?: number; + readonly hooray?: number; + readonly laugh?: number; + readonly rocket?: number; + readonly total_count?: number; + readonly url?: string; + }; + readonly repository_url?: string; + /** + * @description State of the issue; either 'open' or 'closed' + * @enum {string} + */ + readonly state: "open" | "closed"; + readonly timeline_url?: string; + readonly title?: string; + readonly updated_at?: string; + readonly url?: string; + readonly user?: { + readonly avatar_url?: string; + readonly events_url?: string; + readonly followers_url?: string; + readonly following_url?: string; + readonly gists_url?: string; + readonly gravatar_id?: string; + readonly html_url?: string; + /** Format: int64 */ + readonly id?: number; + readonly login?: string; + readonly node_id?: string; + readonly organizations_url?: string; + readonly received_events_url?: string; + readonly repos_url?: string; + readonly site_admin?: boolean; + readonly starred_url?: string; + readonly subscriptions_url?: string; + readonly type?: string; + readonly url?: string; + }; }; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; + }; + /** issue_comment deleted event */ + readonly "webhook-issue-comment-deleted": { + /** @enum {string} */ + readonly action: "deleted"; + readonly comment: components["schemas"]["webhooks_issue_comment"]; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. */ @@ -44272,7 +45419,7 @@ export type components = { readonly created_at: string | null; readonly description: string | null; /** @description The list of events for the GitHub app */ - readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "pull_request_review_thread")[]; + readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; /** Format: uri */ readonly external_url: string | null; /** Format: uri */ @@ -44357,7 +45504,7 @@ export type components = { /** @enum {string} */ readonly organization_plan?: "read" | "write"; /** @enum {string} */ - readonly organization_projects?: "read" | "write" | "admin"; + readonly organization_projects?: "read" | "write"; /** @enum {string} */ readonly organization_secrets?: "read" | "write"; /** @enum {string} */ @@ -44373,7 +45520,7 @@ export type components = { /** @enum {string} */ readonly repository_hooks?: "read" | "write"; /** @enum {string} */ - readonly repository_projects?: "read" | "write" | "admin"; + readonly repository_projects?: "read" | "write"; /** @enum {string} */ readonly secret_scanning_alerts?: "read" | "write"; /** @enum {string} */ @@ -44426,6 +45573,12 @@ export type components = { }; /** Format: uri */ readonly repository_url: string; + /** Sub-issues Summary */ + readonly sub_issues_summary?: { + readonly total: number; + readonly completed: number; + readonly percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -44595,16 +45748,18 @@ export type components = { readonly subscriptions_url?: string; readonly type?: string; readonly url?: string; + readonly user_view_type?: string; }; }; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user"]; }; - /** issue_comment deleted event */ - readonly "webhook-issue-comment-deleted": { + /** issue_comment edited event */ + readonly "webhook-issue-comment-edited": { /** @enum {string} */ - readonly action: "deleted"; + readonly action: "edited"; + readonly changes: components["schemas"]["webhooks_changes"]; readonly comment: components["schemas"]["webhooks_issue_comment"]; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; @@ -44810,7 +45965,7 @@ export type components = { readonly created_at: string | null; readonly description: string | null; /** @description The list of events for the GitHub app */ - readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; + readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "pull_request_review_thread")[]; /** Format: uri */ readonly external_url: string | null; /** Format: uri */ @@ -44895,7 +46050,7 @@ export type components = { /** @enum {string} */ readonly organization_plan?: "read" | "write"; /** @enum {string} */ - readonly organization_projects?: "read" | "write"; + readonly organization_projects?: "read" | "write" | "admin"; /** @enum {string} */ readonly organization_secrets?: "read" | "write"; /** @enum {string} */ @@ -44964,6 +46119,12 @@ export type components = { }; /** Format: uri */ readonly repository_url: string; + /** Sub-issues Summary */ + readonly sub_issues_summary?: { + readonly total: number; + readonly completed: number; + readonly percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -45133,22 +46294,37 @@ export type components = { readonly subscriptions_url?: string; readonly type?: string; readonly url?: string; - readonly user_view_type?: string; }; }; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user"]; }; - /** issue_comment edited event */ - readonly "webhook-issue-comment-edited": { - /** @enum {string} */ - readonly action: "edited"; - readonly changes: components["schemas"]["webhooks_changes"]; - readonly comment: components["schemas"]["webhooks_issue_comment"]; + /** issues assigned event */ + readonly "webhook-issues-assigned": { + /** + * @description The action that was performed. + * @enum {string} + */ + readonly action: "assigned"; + readonly assignee?: components["schemas"]["webhooks_user"]; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; - /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. */ + readonly issue: components["schemas"]["webhooks_issue"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; + }; + /** issues closed event */ + readonly "webhook-issues-closed": { + /** + * @description The action that was performed. + * @enum {string} + */ + readonly action: "closed"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ readonly issue: { /** @enum {string|null} */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; @@ -45350,7 +46526,7 @@ export type components = { readonly created_at: string | null; readonly description: string | null; /** @description The list of events for the GitHub app */ - readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "pull_request_review_thread")[]; + readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "security_and_analysis" | "reminder" | "pull_request_review_thread")[]; /** Format: uri */ readonly external_url: string | null; /** Format: uri */ @@ -45504,6 +46680,12 @@ export type components = { }; /** Format: uri */ readonly repository_url: string; + /** Sub-issues Summary */ + readonly sub_issues_summary?: { + readonly total: number; + readonly completed: number; + readonly percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -45562,71 +46744,20 @@ export type components = { } | null; } & { readonly active_lock_reason?: string | null; - /** User */ - readonly assignee: { - /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; - /** Format: uri-template */ - readonly events_url?: string; - /** Format: uri */ - readonly followers_url?: string; - /** Format: uri-template */ - readonly following_url?: string; - /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; - /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; - /** Format: uri */ - readonly organizations_url?: string; - /** Format: uri */ - readonly received_events_url?: string; - /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; - /** Format: uri-template */ - readonly starred_url?: string; - /** Format: uri */ - readonly subscriptions_url?: string; - /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; - } | null; + readonly assignee?: Record; readonly assignees?: readonly Record[]; readonly author_association?: string; readonly body?: string | null; - readonly closed_at?: string | null; + readonly closed_at: string | null; readonly comments?: number; readonly comments_url?: string; readonly created_at?: string; readonly events_url?: string; readonly html_url?: string; readonly id?: number; - readonly labels: readonly { - /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; - /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; - /** - * Format: uri - * @description URL for the label - */ - readonly url: string; - }[]; + readonly labels?: readonly Record[]; readonly labels_url?: string; - readonly locked: boolean; + readonly locked?: boolean; readonly milestone?: Record; readonly node_id?: string; readonly number?: number; @@ -45644,11 +46775,8 @@ export type components = { readonly url?: string; }; readonly repository_url?: string; - /** - * @description State of the issue; either 'open' or 'closed' - * @enum {string} - */ - readonly state: "open" | "closed"; + /** @enum {string} */ + readonly state: "closed" | "open"; readonly timeline_url?: string; readonly title?: string; readonly updated_at?: string; @@ -45673,37 +46801,23 @@ export type components = { readonly subscriptions_url?: string; readonly type?: string; readonly url?: string; + readonly user_view_type?: string; }; }; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user"]; }; - /** issues assigned event */ - readonly "webhook-issues-assigned": { - /** - * @description The action that was performed. - * @enum {string} - */ - readonly action: "assigned"; - readonly assignee?: components["schemas"]["webhooks_user"]; + /** issues deleted event */ + readonly "webhook-issues-deleted": { + /** @enum {string} */ + readonly action: "deleted"; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; - readonly issue: components["schemas"]["webhooks_issue"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user"]; - }; - /** issues closed event */ - readonly "webhook-issues-closed": { /** - * @description The action that was performed. - * @enum {string} + * Issue + * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ - readonly action: "closed"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ readonly issue: { /** @enum {string|null} */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; @@ -45740,7 +46854,7 @@ export type components = { /** Format: uri */ readonly subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; readonly user_view_type?: string; @@ -45777,10 +46891,9 @@ export type components = { /** Format: uri */ readonly subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; - readonly user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -45865,7 +46978,7 @@ export type components = { /** Format: uri */ readonly subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; readonly user_view_type?: string; @@ -45905,7 +47018,7 @@ export type components = { readonly created_at: string | null; readonly description: string | null; /** @description The list of events for the GitHub app */ - readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "security_and_analysis" | "reminder" | "pull_request_review_thread")[]; + readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder")[]; /** Format: uri */ readonly external_url: string | null; /** Format: uri */ @@ -45990,7 +47103,7 @@ export type components = { /** @enum {string} */ readonly organization_plan?: "read" | "write"; /** @enum {string} */ - readonly organization_projects?: "read" | "write" | "admin"; + readonly organization_projects?: "read" | "write"; /** @enum {string} */ readonly organization_secrets?: "read" | "write"; /** @enum {string} */ @@ -46059,6 +47172,12 @@ export type components = { }; /** Format: uri */ readonly repository_url: string; + /** Sub-issues Summary */ + readonly sub_issues_summary?: { + readonly total: number; + readonly completed: number; + readonly percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -46110,81 +47229,20 @@ export type components = { /** Format: uri */ readonly subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; readonly user_view_type?: string; } | null; - } & { - readonly active_lock_reason?: string | null; - readonly assignee?: Record; - readonly assignees?: readonly Record[]; - readonly author_association?: string; - readonly body?: string | null; - readonly closed_at: string | null; - readonly comments?: number; - readonly comments_url?: string; - readonly created_at?: string; - readonly events_url?: string; - readonly html_url?: string; - readonly id?: number; - readonly labels?: readonly Record[]; - readonly labels_url?: string; - readonly locked?: boolean; - readonly milestone?: Record; - readonly node_id?: string; - readonly number?: number; - readonly performed_via_github_app?: Record; - readonly reactions?: { - readonly "+1"?: number; - readonly "-1"?: number; - readonly confused?: number; - readonly eyes?: number; - readonly heart?: number; - readonly hooray?: number; - readonly laugh?: number; - readonly rocket?: number; - readonly total_count?: number; - readonly url?: string; - }; - readonly repository_url?: string; - /** @enum {string} */ - readonly state: "closed" | "open"; - readonly timeline_url?: string; - readonly title?: string; - readonly updated_at?: string; - readonly url?: string; - readonly user?: { - readonly avatar_url?: string; - readonly events_url?: string; - readonly followers_url?: string; - readonly following_url?: string; - readonly gists_url?: string; - readonly gravatar_id?: string; - readonly html_url?: string; - /** Format: int64 */ - readonly id?: number; - readonly login?: string; - readonly node_id?: string; - readonly organizations_url?: string; - readonly received_events_url?: string; - readonly repos_url?: string; - readonly site_admin?: boolean; - readonly starred_url?: string; - readonly subscriptions_url?: string; - readonly type?: string; - readonly url?: string; - readonly user_view_type?: string; - }; }; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user"]; }; - /** issues deleted event */ - readonly "webhook-issues-deleted": { + /** issues demilestoned event */ + readonly "webhook-issues-demilestoned": { /** @enum {string} */ - readonly action: "deleted"; + readonly action: "demilestoned"; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; /** @@ -46227,10 +47285,9 @@ export type components = { /** Format: uri */ readonly subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; - readonly user_view_type?: string; } | null; readonly assignees: readonly ({ /** Format: uri */ @@ -46264,7 +47321,7 @@ export type components = { /** Format: uri */ readonly subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; } | null)[]; @@ -46290,7 +47347,7 @@ export type components = { readonly html_url: string; /** Format: int64 */ readonly id: number; - readonly labels?: readonly { + readonly labels?: readonly ({ /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; @@ -46304,7 +47361,7 @@ export type components = { * @description URL for the label */ readonly url: string; - }[]; + } | null)[]; /** Format: uri-template */ readonly labels_url: string; readonly locked?: boolean; @@ -46351,7 +47408,7 @@ export type components = { /** Format: uri */ readonly subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; readonly user_view_type?: string; @@ -46391,7 +47448,7 @@ export type components = { readonly created_at: string | null; readonly description: string | null; /** @description The list of events for the GitHub app */ - readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder")[]; + readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; /** Format: uri */ readonly external_url: string | null; /** Format: uri */ @@ -46476,7 +47533,7 @@ export type components = { /** @enum {string} */ readonly organization_plan?: "read" | "write"; /** @enum {string} */ - readonly organization_projects?: "read" | "write"; + readonly organization_projects?: "read" | "write" | "admin"; /** @enum {string} */ readonly organization_secrets?: "read" | "write"; /** @enum {string} */ @@ -46545,6 +47602,12 @@ export type components = { }; /** Format: uri */ readonly repository_url: string; + /** Sub-issues Summary */ + readonly sub_issues_summary?: { + readonly total: number; + readonly completed: number; + readonly percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -46596,20 +47659,32 @@ export type components = { /** Format: uri */ readonly subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; + readonly milestone?: components["schemas"]["webhooks_milestone"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user"]; }; - /** issues demilestoned event */ - readonly "webhook-issues-demilestoned": { + /** issues edited event */ + readonly "webhook-issues-edited": { /** @enum {string} */ - readonly action: "demilestoned"; + readonly action: "edited"; + /** @description The changes to the issue. */ + readonly changes: { + readonly body?: { + /** @description The previous version of the body. */ + readonly from: string; + }; + readonly title?: { + /** @description The previous version of the title. */ + readonly from: string; + }; + }; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; /** @@ -46655,6 +47730,7 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly assignees: readonly ({ /** Format: uri */ @@ -46714,7 +47790,7 @@ export type components = { readonly html_url: string; /** Format: int64 */ readonly id: number; - readonly labels?: readonly ({ + readonly labels?: readonly { /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; @@ -46728,7 +47804,7 @@ export type components = { * @description URL for the label */ readonly url: string; - } | null)[]; + }[]; /** Format: uri-template */ readonly labels_url: string; readonly locked?: boolean; @@ -46815,7 +47891,7 @@ export type components = { readonly created_at: string | null; readonly description: string | null; /** @description The list of events for the GitHub app */ - readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; + readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "security_and_analysis" | "pull_request_review_thread" | "reminder")[]; /** Format: uri */ readonly external_url: string | null; /** Format: uri */ @@ -46969,6 +48045,12 @@ export type components = { }; /** Format: uri */ readonly repository_url: string; + /** Sub-issues Summary */ + readonly sub_issues_summary?: { + readonly total: number; + readonly completed: number; + readonly percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -47026,26 +48108,15 @@ export type components = { readonly user_view_type?: string; } | null; }; - readonly milestone?: components["schemas"]["webhooks_milestone"]; + readonly label?: components["schemas"]["webhooks_label"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user"]; }; - /** issues edited event */ - readonly "webhook-issues-edited": { + /** issues labeled event */ + readonly "webhook-issues-labeled": { /** @enum {string} */ - readonly action: "edited"; - /** @description The changes to the issue. */ - readonly changes: { - readonly body?: { - /** @description The previous version of the body. */ - readonly from: string; - }; - readonly title?: { - /** @description The previous version of the title. */ - readonly from: string; - }; - }; + readonly action: "labeled"; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; /** @@ -47252,7 +48323,7 @@ export type components = { readonly created_at: string | null; readonly description: string | null; /** @description The list of events for the GitHub app */ - readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "security_and_analysis" | "pull_request_review_thread" | "reminder")[]; + readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "reminder")[]; /** Format: uri */ readonly external_url: string | null; /** Format: uri */ @@ -47406,6 +48477,12 @@ export type components = { }; /** Format: uri */ readonly repository_url: string; + /** Sub-issues Summary */ + readonly sub_issues_summary?: { + readonly total: number; + readonly completed: number; + readonly percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -47468,10 +48545,10 @@ export type components = { readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user"]; }; - /** issues labeled event */ - readonly "webhook-issues-labeled": { + /** issues locked event */ + readonly "webhook-issues-locked": { /** @enum {string} */ - readonly action: "labeled"; + readonly action: "locked"; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; /** @@ -47514,7 +48591,7 @@ export type components = { /** Format: uri */ readonly subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; readonly user_view_type?: string; @@ -47551,9 +48628,10 @@ export type components = { /** Format: uri */ readonly subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -47577,7 +48655,7 @@ export type components = { readonly html_url: string; /** Format: int64 */ readonly id: number; - readonly labels?: readonly { + readonly labels?: readonly ({ /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; @@ -47591,10 +48669,11 @@ export type components = { * @description URL for the label */ readonly url: string; - }[]; + } | null)[]; /** Format: uri-template */ readonly labels_url: string; - readonly locked?: boolean; + /** @enum {boolean} */ + readonly locked: true; /** * Milestone * @description A collection of related issues and pull requests. @@ -47638,7 +48717,7 @@ export type components = { /** Format: uri */ readonly subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; readonly user_view_type?: string; @@ -47678,7 +48757,7 @@ export type components = { readonly created_at: string | null; readonly description: string | null; /** @description The list of events for the GitHub app */ - readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "reminder")[]; + readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "security_and_analysis")[]; /** Format: uri */ readonly external_url: string | null; /** Format: uri */ @@ -47763,7 +48842,7 @@ export type components = { /** @enum {string} */ readonly organization_plan?: "read" | "write"; /** @enum {string} */ - readonly organization_projects?: "read" | "write" | "admin"; + readonly organization_projects?: "read" | "write"; /** @enum {string} */ readonly organization_secrets?: "read" | "write"; /** @enum {string} */ @@ -47832,6 +48911,12 @@ export type components = { }; /** Format: uri */ readonly repository_url: string; + /** Sub-issues Summary */ + readonly sub_issues_summary?: { + readonly total: number; + readonly completed: number; + readonly percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -47883,21 +48968,20 @@ export type components = { /** Format: uri */ readonly subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; - readonly label?: components["schemas"]["webhooks_label"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user"]; }; - /** issues locked event */ - readonly "webhook-issues-locked": { + /** issues milestoned event */ + readonly "webhook-issues-milestoned": { /** @enum {string} */ - readonly action: "locked"; + readonly action: "milestoned"; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; /** @@ -47943,7 +49027,6 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; - readonly user_view_type?: string; } | null; readonly assignees: readonly ({ /** Format: uri */ @@ -47980,7 +49063,6 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; - readonly user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -48021,8 +49103,7 @@ export type components = { } | null)[]; /** Format: uri-template */ readonly labels_url: string; - /** @enum {boolean} */ - readonly locked: true; + readonly locked?: boolean; /** * Milestone * @description A collection of related issues and pull requests. @@ -48066,7 +49147,7 @@ export type components = { /** Format: uri */ readonly subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; readonly user_view_type?: string; @@ -48106,7 +49187,7 @@ export type components = { readonly created_at: string | null; readonly description: string | null; /** @description The list of events for the GitHub app */ - readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "security_and_analysis")[]; + readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder")[]; /** Format: uri */ readonly external_url: string | null; /** Format: uri */ @@ -48191,7 +49272,7 @@ export type components = { /** @enum {string} */ readonly organization_plan?: "read" | "write"; /** @enum {string} */ - readonly organization_projects?: "read" | "write"; + readonly organization_projects?: "read" | "write" | "admin"; /** @enum {string} */ readonly organization_secrets?: "read" | "write"; /** @enum {string} */ @@ -48260,430 +49341,12 @@ export type components = { }; /** Format: uri */ readonly repository_url: string; - /** - * @description State of the issue; either 'open' or 'closed' - * @enum {string} - */ - readonly state?: "open" | "closed"; - readonly state_reason?: string | null; - /** Format: uri */ - readonly timeline_url?: string; - /** @description Title of the issue */ - readonly title: string; - /** Format: date-time */ - readonly updated_at: string; - /** - * Format: uri - * @description URL for the issue - */ - readonly url: string; - /** User */ - readonly user: { - /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; - /** Format: uri-template */ - readonly events_url?: string; - /** Format: uri */ - readonly followers_url?: string; - /** Format: uri-template */ - readonly following_url?: string; - /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; - /** Format: uri */ - readonly html_url?: string; - /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; - /** Format: uri */ - readonly organizations_url?: string; - /** Format: uri */ - readonly received_events_url?: string; - /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; - /** Format: uri-template */ - readonly starred_url?: string; - /** Format: uri */ - readonly subscriptions_url?: string; - /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; - } | null; - }; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user"]; - }; - /** issues milestoned event */ - readonly "webhook-issues-milestoned": { - /** @enum {string} */ - readonly action: "milestoned"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - /** - * Issue - * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. - */ - readonly issue: { - /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ - readonly assignee?: { - /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; - /** Format: uri-template */ - readonly events_url?: string; - /** Format: uri */ - readonly followers_url?: string; - /** Format: uri-template */ - readonly following_url?: string; - /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; - /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; - /** Format: uri */ - readonly organizations_url?: string; - /** Format: uri */ - readonly received_events_url?: string; - /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; - /** Format: uri-template */ - readonly starred_url?: string; - /** Format: uri */ - readonly subscriptions_url?: string; - /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ - readonly url?: string; - } | null; - readonly assignees: readonly ({ - /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; - /** Format: uri-template */ - readonly events_url?: string; - /** Format: uri */ - readonly followers_url?: string; - /** Format: uri-template */ - readonly following_url?: string; - /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; - /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; - /** Format: uri */ - readonly organizations_url?: string; - /** Format: uri */ - readonly received_events_url?: string; - /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; - /** Format: uri-template */ - readonly starred_url?: string; - /** Format: uri */ - readonly subscriptions_url?: string; - /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ - readonly url?: string; - } | null)[]; - /** - * AuthorAssociation - * @description How the author is associated with the repository. - * @enum {string} - */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ - readonly body: string | null; - /** Format: date-time */ - readonly closed_at: string | null; - readonly comments: number; - /** Format: uri */ - readonly comments_url: string; - /** Format: date-time */ - readonly created_at: string; - readonly draft?: boolean; - /** Format: uri */ - readonly events_url: string; - /** Format: uri */ - readonly html_url: string; - /** Format: int64 */ - readonly id: number; - readonly labels?: readonly ({ - /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; - /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; - /** - * Format: uri - * @description URL for the label - */ - readonly url: string; - } | null)[]; - /** Format: uri-template */ - readonly labels_url: string; - readonly locked?: boolean; - /** - * Milestone - * @description A collection of related issues and pull requests. - */ - readonly milestone: { - /** Format: date-time */ - readonly closed_at: string | null; - readonly closed_issues: number; - /** Format: date-time */ - readonly created_at: string; - /** User */ - readonly creator: { - /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; - /** Format: uri-template */ - readonly events_url?: string; - /** Format: uri */ - readonly followers_url?: string; - /** Format: uri-template */ - readonly following_url?: string; - /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; - /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; - /** Format: uri */ - readonly organizations_url?: string; - /** Format: uri */ - readonly received_events_url?: string; - /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; - /** Format: uri-template */ - readonly starred_url?: string; - /** Format: uri */ - readonly subscriptions_url?: string; - /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; - } | null; - readonly description: string | null; - /** Format: date-time */ - readonly due_on: string | null; - /** Format: uri */ - readonly html_url: string; - readonly id: number; - /** Format: uri */ - readonly labels_url: string; - readonly node_id: string; - /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; - /** - * @description The state of the milestone. - * @enum {string} - */ - readonly state: "open" | "closed"; - /** @description The title of the milestone. */ - readonly title: string; - /** Format: date-time */ - readonly updated_at: string; - /** Format: uri */ - readonly url: string; - } | null; - readonly node_id: string; - readonly number: number; - /** - * App - * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. - */ - readonly performed_via_github_app?: { - /** Format: date-time */ - readonly created_at: string | null; - readonly description: string | null; - /** @description The list of events for the GitHub app */ - readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder")[]; - /** Format: uri */ - readonly external_url: string | null; - /** Format: uri */ - readonly html_url: string; - /** @description Unique identifier of the GitHub app */ - readonly id: number | null; - /** @description The name of the GitHub app */ - readonly name: string; - readonly node_id: string; - /** User */ - readonly owner: { - /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; - /** Format: uri-template */ - readonly events_url?: string; - /** Format: uri */ - readonly followers_url?: string; - /** Format: uri-template */ - readonly following_url?: string; - /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; - /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; - /** Format: uri */ - readonly organizations_url?: string; - /** Format: uri */ - readonly received_events_url?: string; - /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; - /** Format: uri-template */ - readonly starred_url?: string; - /** Format: uri */ - readonly subscriptions_url?: string; - /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; - } | null; - /** @description The set of permissions for the GitHub app */ - readonly permissions?: { - /** @enum {string} */ - readonly actions?: "read" | "write"; - /** @enum {string} */ - readonly administration?: "read" | "write"; - /** @enum {string} */ - readonly checks?: "read" | "write"; - /** @enum {string} */ - readonly content_references?: "read" | "write"; - /** @enum {string} */ - readonly contents?: "read" | "write"; - /** @enum {string} */ - readonly deployments?: "read" | "write"; - /** @enum {string} */ - readonly discussions?: "read" | "write"; - /** @enum {string} */ - readonly emails?: "read" | "write"; - /** @enum {string} */ - readonly environments?: "read" | "write"; - /** @enum {string} */ - readonly issues?: "read" | "write"; - /** @enum {string} */ - readonly keys?: "read" | "write"; - /** @enum {string} */ - readonly members?: "read" | "write"; - /** @enum {string} */ - readonly metadata?: "read" | "write"; - /** @enum {string} */ - readonly organization_administration?: "read" | "write"; - /** @enum {string} */ - readonly organization_hooks?: "read" | "write"; - /** @enum {string} */ - readonly organization_packages?: "read" | "write"; - /** @enum {string} */ - readonly organization_plan?: "read" | "write"; - /** @enum {string} */ - readonly organization_projects?: "read" | "write" | "admin"; - /** @enum {string} */ - readonly organization_secrets?: "read" | "write"; - /** @enum {string} */ - readonly organization_self_hosted_runners?: "read" | "write"; - /** @enum {string} */ - readonly organization_user_blocking?: "read" | "write"; - /** @enum {string} */ - readonly packages?: "read" | "write"; - /** @enum {string} */ - readonly pages?: "read" | "write"; - /** @enum {string} */ - readonly pull_requests?: "read" | "write"; - /** @enum {string} */ - readonly repository_hooks?: "read" | "write"; - /** @enum {string} */ - readonly repository_projects?: "read" | "write"; - /** @enum {string} */ - readonly secret_scanning_alerts?: "read" | "write"; - /** @enum {string} */ - readonly secrets?: "read" | "write"; - /** @enum {string} */ - readonly security_events?: "read" | "write"; - /** @enum {string} */ - readonly security_scanning_alert?: "read" | "write"; - /** @enum {string} */ - readonly single_file?: "read" | "write"; - /** @enum {string} */ - readonly statuses?: "read" | "write"; - /** @enum {string} */ - readonly team_discussions?: "read" | "write"; - /** @enum {string} */ - readonly vulnerability_alerts?: "read" | "write"; - /** @enum {string} */ - readonly workflows?: "read" | "write"; - }; - /** @description The slug name of the GitHub app */ - readonly slug?: string; - /** Format: date-time */ - readonly updated_at: string | null; - } | null; - readonly pull_request?: { - /** Format: uri */ - readonly diff_url?: string; - /** Format: uri */ - readonly html_url?: string; - /** Format: date-time */ - readonly merged_at?: string | null; - /** Format: uri */ - readonly patch_url?: string; - /** Format: uri */ - readonly url?: string; + /** Sub-issues Summary */ + readonly sub_issues_summary?: { + readonly total: number; + readonly completed: number; + readonly percent_completed: number; }; - /** Reactions */ - readonly reactions: { - readonly "+1": number; - readonly "-1": number; - readonly confused: number; - readonly eyes: number; - readonly heart: number; - readonly hooray: number; - readonly laugh: number; - readonly rocket: number; - readonly total_count: number; - /** Format: uri */ - readonly url: string; - }; - /** Format: uri */ - readonly repository_url: string; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -49110,6 +49773,12 @@ export type components = { }; /** Format: uri */ readonly repository_url: string; + /** Sub-issues Summary */ + readonly sub_issues_summary?: { + readonly total: number; + readonly completed: number; + readonly percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -49776,6 +50445,12 @@ export type components = { }; /** Format: uri */ readonly repository_url: string; + /** Sub-issues Summary */ + readonly sub_issues_summary?: { + readonly total: number; + readonly completed: number; + readonly percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -50211,6 +50886,12 @@ export type components = { }; /** Format: uri */ readonly repository_url: string; + /** Sub-issues Summary */ + readonly sub_issues_summary?: { + readonly total: number; + readonly completed: number; + readonly percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -50636,6 +51317,12 @@ export type components = { }; /** Format: uri */ readonly repository_url: string; + /** Sub-issues Summary */ + readonly sub_issues_summary?: { + readonly total: number; + readonly completed: number; + readonly percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -51344,6 +52031,12 @@ export type components = { }; /** Format: uri */ readonly repository_url: string; + /** Sub-issues Summary */ + readonly sub_issues_summary?: { + readonly total: number; + readonly completed: number; + readonly percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -82571,6 +83264,45 @@ export type components = { readonly repository: components["schemas"]["repository-webhooks"]; readonly sender?: components["schemas"]["simple-user"]; }; + /** secret_scanning_scan completed event */ + readonly "webhook-secret-scanning-scan-completed": { + /** @enum {string} */ + readonly action: "completed"; + /** + * @description What type of scan was completed + * @enum {string} + */ + readonly type: "backfill" | "custom-pattern-backfill" | "pattern-version-backfill"; + /** + * @description What type of content was scanned + * @enum {string} + */ + readonly source: "git" | "issues" | "pull-requests" | "discussions" | "wiki"; + /** + * Format: date-time + * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + readonly started_at: string; + /** + * Format: date-time + * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + readonly completed_at: string; + /** @description List of patterns that were updated. This will be empty for normal backfill scans or custom pattern updates */ + readonly secret_types?: readonly string[] | null; + /** @description If the scan was triggered by a custom pattern update, this will be the name of the pattern that was updated */ + readonly custom_pattern_name?: string | null; + /** + * @description If the scan was triggered by a custom pattern update, this will be the scope of the pattern that was updated + * @enum {string|null} + */ + readonly custom_pattern_scope?: "repository" | "organization" | "enterprise" | null; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; + }; /** security_advisory published event */ readonly "webhook-security-advisory-published": { /** @enum {string} */ @@ -82850,6 +83582,7 @@ export type components = { readonly reason: "expired_key" | "not_signing_key" | "gpgverify_error" | "gpgverify_unavailable" | "unsigned" | "unknown_signature_type" | "no_user" | "unverified_email" | "bad_email" | "unknown_key" | "malformed_signature" | "invalid" | "valid" | "bad_cert" | "ocsp_pending"; readonly signature: string | null; readonly verified: boolean; + readonly verified_at?: string | null; }; }; /** User */ @@ -86045,8 +86778,8 @@ export type components = { readonly "application/json": components["schemas"]["basic-error"]; }; }; - /** @description Internal Error */ - readonly internal_error: { + /** @description Conflict */ + readonly conflict: { headers: { readonly [name: string]: unknown; }; @@ -86054,14 +86787,12 @@ export type components = { readonly "application/json": components["schemas"]["basic-error"]; }; }; - /** @description Copilot Usage Merics API setting is disabled at the organization or enterprise level. */ - readonly usage_metrics_api_disabled: { + /** @description A header with no content is returned. */ + readonly no_content: { headers: { readonly [name: string]: unknown; }; - content: { - readonly "application/json": components["schemas"]["basic-error"]; - }; + content?: never; }; /** @description Service unavailable */ readonly service_unavailable: { @@ -86102,8 +86833,17 @@ export type components = { readonly "application/json": components["schemas"]["basic-error"]; }; }; - /** @description Conflict */ - readonly conflict: { + /** @description Billing usage report response for an organization */ + readonly billing_usage_report_org: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["billing-usage-report"]; + }; + }; + /** @description Internal Error */ + readonly internal_error: { headers: { readonly [name: string]: unknown; }; @@ -86148,12 +86888,14 @@ export type components = { }; }; }; - /** @description A header with no content is returned. */ - readonly no_content: { + /** @description Copilot Usage Merics API setting is disabled at the organization or enterprise level. */ + readonly usage_metrics_api_disabled: { headers: { readonly [name: string]: unknown; }; - content?: never; + content: { + readonly "application/json": components["schemas"]["basic-error"]; + }; }; /** @description The value of `per_page` multiplied by `page` cannot be greater than 10000. */ readonly package_es_list_error: { @@ -86198,6 +86940,24 @@ export type components = { readonly "application/json": components["schemas"]["basic-error"]; }; }; + /** @description Bad Request */ + readonly code_scanning_bad_request: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["basic-error"]; + }; + }; + /** @description Response if the repository is archived, if GitHub Advanced Security is not enabled for this repository or if rate limit is exceeded */ + readonly code_scanning_autofix_create_forbidden: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["basic-error"]; + }; + }; /** @description Found */ readonly found: { headers: { @@ -86271,6 +87031,8 @@ export type components = { readonly "classroom-id": number; /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ readonly enterprise: string; + /** @description The unique identifier of the code security configuration. */ + readonly "configuration-id": number; /** @description A comma-separated list of states. If specified, only alerts with these states will be returned. * * Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` */ @@ -86301,9 +87063,7 @@ export type components = { readonly "pagination-last": number; /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ readonly "secret-scanning-alert-state": "open" | "resolved"; - /** @description A comma-separated list of secret types to return. By default all secret types are returned. - * See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" - * for a complete list of secret types. */ + /** @description A comma-separated list of secret types to return. All default secret patterns are returned. To return experimental patterns, pass the token name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. */ readonly "secret-scanning-alert-secret-type": string; /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ readonly "secret-scanning-alert-resolution": string; @@ -86315,10 +87075,6 @@ export type components = { readonly "secret-scanning-alert-publicly-leaked": boolean; /** @description A boolean value representing whether or not to filter alerts by the multi-repo tag being present. */ readonly "secret-scanning-alert-multi-repo": boolean; - /** @description The slug of the enterprise team name. */ - readonly "enterprise-team-slug": string; - /** @description The slug of the team name. */ - readonly "team-slug": string; /** @description The unique identifier of the gist. */ readonly "gist-id": string; /** @description The unique identifier of the comment. */ @@ -86347,6 +87103,14 @@ export type components = { readonly "since-org": number; /** @description The organization name. The name is not case sensitive. */ readonly org: string; + /** @description If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2024`. Default value is the current year. */ + readonly "billing-usage-report-year": number; + /** @description If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. */ + readonly "billing-usage-report-month": number; + /** @description If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. */ + readonly "billing-usage-report-day": number; + /** @description If specified, only return results for a single hour. The value of `hour` is an integer between `0` and `23`. */ + readonly "billing-usage-report-hour": number; /** @description The unique identifier of the repository. */ readonly "repository-id": number; /** @description Only return runner groups that are allowed to be used by this repository. */ @@ -86369,26 +87133,30 @@ export type components = { readonly "tool-name": components["schemas"]["code-scanning-analysis-tool-name"]; /** @description The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both. */ readonly "tool-guid": components["schemas"]["code-scanning-analysis-tool-guid"]; - /** @description The unique identifier of the code security configuration. */ - readonly "configuration-id": number; /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ readonly "hook-id": number; /** @description The type of the actor */ - readonly "api-insights-actor-type": "installations" | "classic_pats" | "fine_grained_pats" | "oauth_apps" | "github_apps_user_to_server"; + readonly "api-insights-actor-type": "installation" | "classic_pat" | "fine_grained_pat" | "oauth_app" | "github_app_user_to_server"; /** @description The ID of the actor */ readonly "api-insights-actor-id": number; - /** @description The minimum timestamp to query for stats */ + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ readonly "api-insights-min-timestamp": string; - /** @description The maximum timestamp to query for stats */ + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ readonly "api-insights-max-timestamp": string; /** @description The property to sort the results by. */ readonly "api-insights-route-stats-sort": readonly ("last_rate_limited_timestamp" | "last_request_timestamp" | "rate_limited_request_count" | "http_method" | "api_route" | "total_request_count")[]; + /** @description Providing a substring will filter results where the API route contains the substring. This is a case-insensitive search. */ + readonly "api-insights-api-route-substring": string; /** @description The property to sort the results by. */ readonly "api-insights-sort": readonly ("last_rate_limited_timestamp" | "last_request_timestamp" | "rate_limited_request_count" | "subject_name" | "total_request_count")[]; + /** @description Providing a substring will filter results where the subject name contains the substring. This is a case-insensitive search. */ + readonly "api-insights-subject-name-substring": string; /** @description The ID of the user to query for stats */ readonly "api-insights-user-id": string; /** @description The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) */ readonly "api-insights-timestamp-increment": string; + /** @description Providing a substring will filter results where the actor name contains the substring. This is a case-insensitive search. */ + readonly "api-insights-actor-name-substring": string; /** @description The unique identifier of the invitation. */ readonly "invitation-id": number; /** @description The name of the codespace. */ @@ -86397,6 +87165,8 @@ export type components = { readonly "migration-id": number; /** @description repo_name parameter */ readonly "repo-name": string; + /** @description The slug of the team name. */ + readonly "team-slug": string; /** @description The unique identifier of the role. */ readonly "role-id": number; /** @description The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -86433,8 +87203,8 @@ export type components = { readonly "ruleset-targets": string; /** @description The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. */ readonly "ref-in-query": string; - /** @description The name of the repository to filter on. When specified, only rule evaluations from this repository will be returned. */ - readonly "repository-name-in-query": number; + /** @description The name of the repository to filter on. */ + readonly "repository-name-in-query": string; /** @description The time period to filter by. * * For example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for insights that occurred in the past 7 days (168 hours). */ @@ -87519,13 +88289,15 @@ export interface operations { readonly 304: components["responses"]["not_modified"]; }; }; - readonly "copilot/list-copilot-seats-for-enterprise": { + readonly "code-security/get-configurations-for-enterprise": { readonly parameters: { readonly query?: { - /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - readonly page?: components["parameters"]["page"]; /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ readonly per_page?: number; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly before?: components["parameters"]["pagination-before"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly after?: components["parameters"]["pagination-after"]; }; readonly header?: never; readonly path: { @@ -87539,39 +88311,164 @@ export interface operations { /** @description Response */ readonly 200: { headers: { - readonly Link: components["headers"]["link"]; readonly [name: string]: unknown; }; content: { - readonly "application/json": { - /** @description The total number of Copilot seats the enterprise is being billed for. Users with access through multiple organizations or enterprise teams are only counted once. */ - readonly total_seats?: number; - readonly seats?: readonly components["schemas"]["copilot-seat-details"][]; + readonly "application/json": readonly components["schemas"]["code-security-configuration"][]; + }; + }; + readonly 403: components["responses"]["forbidden"]; + readonly 404: components["responses"]["not_found"]; + }; + }; + readonly "code-security/create-configuration-for-enterprise": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + readonly enterprise: components["parameters"]["enterprise"]; + }; + readonly cookie?: never; + }; + readonly requestBody: { + readonly content: { + readonly "application/json": { + /** @description The name of the code security configuration. Must be unique within the enterprise. */ + readonly name: string; + /** @description A description of the code security configuration */ + readonly description: string; + /** + * @description The enablement status of GitHub Advanced Security + * @default disabled + * @enum {string} + */ + readonly advanced_security?: "enabled" | "disabled"; + /** + * @description The enablement status of Dependency Graph + * @default enabled + * @enum {string} + */ + readonly dependency_graph?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Automatic dependency submission + * @default disabled + * @enum {string} + */ + readonly dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for Automatic dependency submission */ + readonly dependency_graph_autosubmit_action_options?: { + /** + * @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. + * @default false + */ + readonly labeled_runners?: boolean; }; + /** + * @description The enablement status of Dependabot alerts + * @default disabled + * @enum {string} + */ + readonly dependabot_alerts?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot security updates + * @default disabled + * @enum {string} + */ + readonly dependabot_security_updates?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of code scanning default setup + * @default disabled + * @enum {string} + */ + readonly code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; + readonly code_scanning_default_setup_options?: components["schemas"]["code-scanning-default-setup-options"]; + /** + * @description The enablement status of secret scanning + * @default disabled + * @enum {string} + */ + readonly secret_scanning?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning push protection + * @default disabled + * @enum {string} + */ + readonly secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning validity checks + * @default disabled + * @enum {string} + */ + readonly secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning non provider patterns + * @default disabled + * @enum {string} + */ + readonly secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of private vulnerability reporting + * @default disabled + * @enum {string} + */ + readonly private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; + /** + * @description The enforcement status for a security configuration + * @default enforced + * @enum {string} + */ + readonly enforcement?: "enforced" | "unenforced"; }; }; - readonly 401: components["responses"]["requires_authentication"]; + }; + readonly responses: { + /** @description Successfully created code security configuration */ + readonly 201: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["code-security-configuration"]; + }; + }; + readonly 400: components["responses"]["bad_request"]; readonly 403: components["responses"]["forbidden"]; readonly 404: components["responses"]["not_found"]; - readonly 500: components["responses"]["internal_error"]; }; }; - readonly "copilot/copilot-metrics-for-enterprise": { + readonly "code-security/get-default-configurations-for-enterprise": { readonly parameters: { - readonly query?: { - /** @description Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago. */ - readonly since?: string; - /** @description Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed. */ - readonly until?: string; - /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - readonly page?: components["parameters"]["page"]; - /** @description The number of days of metrics to display per page (max 28). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - readonly per_page?: number; + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + readonly enterprise: components["parameters"]["enterprise"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["code-security-default-configurations"]; + }; }; + }; + }; + readonly "code-security/get-single-configuration-for-enterprise": { + readonly parameters: { + readonly query?: never; readonly header?: never; readonly path: { /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ readonly enterprise: components["parameters"]["enterprise"]; + /** @description The unique identifier of the code security configuration. */ + readonly configuration_id: components["parameters"]["configuration-id"]; }; readonly cookie?: never; }; @@ -87583,31 +88480,233 @@ export interface operations { readonly [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["copilot-usage-metrics-day"][]; + readonly "application/json": components["schemas"]["code-security-configuration"]; }; }; + readonly 304: components["responses"]["not_modified"]; readonly 403: components["responses"]["forbidden"]; readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["usage_metrics_api_disabled"]; - readonly 500: components["responses"]["internal_error"]; }; }; - readonly "copilot/usage-metrics-for-enterprise": { + readonly "code-security/delete-configuration-for-enterprise": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + readonly enterprise: components["parameters"]["enterprise"]; + /** @description The unique identifier of the code security configuration. */ + readonly configuration_id: components["parameters"]["configuration-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + readonly 204: components["responses"]["no_content"]; + readonly 400: components["responses"]["bad_request"]; + readonly 403: components["responses"]["forbidden"]; + readonly 404: components["responses"]["not_found"]; + readonly 409: components["responses"]["conflict"]; + }; + }; + readonly "code-security/update-enterprise-configuration": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + readonly enterprise: components["parameters"]["enterprise"]; + /** @description The unique identifier of the code security configuration. */ + readonly configuration_id: components["parameters"]["configuration-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody: { + readonly content: { + readonly "application/json": { + /** @description The name of the code security configuration. Must be unique across the enterprise. */ + readonly name?: string; + /** @description A description of the code security configuration */ + readonly description?: string; + /** + * @description The enablement status of GitHub Advanced Security. Must be set to enabled if you want to enable any GHAS settings. + * @enum {string} + */ + readonly advanced_security?: "enabled" | "disabled"; + /** + * @description The enablement status of Dependency Graph + * @enum {string} + */ + readonly dependency_graph?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Automatic dependency submission + * @enum {string} + */ + readonly dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for Automatic dependency submission */ + readonly dependency_graph_autosubmit_action_options?: { + /** @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. */ + readonly labeled_runners?: boolean; + }; + /** + * @description The enablement status of Dependabot alerts + * @enum {string} + */ + readonly dependabot_alerts?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot security updates + * @enum {string} + */ + readonly dependabot_security_updates?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of code scanning default setup + * @enum {string} + */ + readonly code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; + readonly code_scanning_default_setup_options?: components["schemas"]["code-scanning-default-setup-options"]; + /** + * @description The enablement status of secret scanning + * @enum {string} + */ + readonly secret_scanning?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning push protection + * @enum {string} + */ + readonly secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning validity checks + * @enum {string} + */ + readonly secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning non-provider patterns + * @enum {string} + */ + readonly secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of private vulnerability reporting + * @enum {string} + */ + readonly private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; + /** + * @description The enforcement status for a security configuration + * @enum {string} + */ + readonly enforcement?: "enforced" | "unenforced"; + }; + }; + }; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["code-security-configuration"]; + }; + }; + readonly 304: components["responses"]["not_modified"]; + readonly 403: components["responses"]["forbidden"]; + readonly 404: components["responses"]["not_found"]; + readonly 409: components["responses"]["conflict"]; + }; + }; + readonly "code-security/attach-enterprise-configuration": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + readonly enterprise: components["parameters"]["enterprise"]; + /** @description The unique identifier of the code security configuration. */ + readonly configuration_id: components["parameters"]["configuration-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody: { + readonly content: { + readonly "application/json": { + /** + * @description The type of repositories to attach the configuration to. `selected` means the configuration will be attached to only the repositories specified by `selected_repository_ids` + * @enum {string} + */ + readonly scope: "all" | "all_without_configurations"; + }; + }; + }; + readonly responses: { + readonly 202: components["responses"]["accepted"]; + readonly 403: components["responses"]["forbidden"]; + readonly 404: components["responses"]["not_found"]; + readonly 409: components["responses"]["conflict"]; + }; + }; + readonly "code-security/set-configuration-as-default-for-enterprise": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + readonly enterprise: components["parameters"]["enterprise"]; + /** @description The unique identifier of the code security configuration. */ + readonly configuration_id: components["parameters"]["configuration-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody: { + readonly content: { + readonly "application/json": { + /** + * @description Specify which types of repository this security configuration should be applied to by default. + * @enum {string} + */ + readonly default_for_new_repos?: "all" | "none" | "private_and_internal" | "public"; + }; + }; + }; + readonly responses: { + /** @description Default successfully changed. */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** + * @description Specifies which types of repository this security configuration is applied to by default. + * @enum {string} + */ + readonly default_for_new_repos?: "all" | "none" | "private_and_internal" | "public"; + readonly configuration?: components["schemas"]["code-security-configuration"]; + }; + }; + }; + readonly 403: components["responses"]["forbidden"]; + readonly 404: components["responses"]["not_found"]; + }; + }; + readonly "code-security/get-repositories-for-enterprise-configuration": { readonly parameters: { readonly query?: { - /** @description Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago. */ - readonly since?: string; - /** @description Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed. */ - readonly until?: string; - /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - readonly page?: components["parameters"]["page"]; - /** @description The number of days of metrics to display per page (max 28). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ readonly per_page?: number; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly before?: components["parameters"]["pagination-before"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly after?: components["parameters"]["pagination-after"]; + /** @description A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned. + * + * Can be: `all`, `attached`, `attaching`, `removed`, `enforced`, `failed`, `updating`, `removed_by_enterprise` */ + readonly status?: string; }; readonly header?: never; readonly path: { /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ readonly enterprise: components["parameters"]["enterprise"]; + /** @description The unique identifier of the code security configuration. */ + readonly configuration_id: components["parameters"]["configuration-id"]; }; readonly cookie?: never; }; @@ -87619,13 +88718,11 @@ export interface operations { readonly [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["copilot-usage-metrics"][]; + readonly "application/json": readonly components["schemas"]["code-security-configuration-repositories"][]; }; }; - readonly 401: components["responses"]["requires_authentication"]; readonly 403: components["responses"]["forbidden"]; readonly 404: components["responses"]["not_found"]; - readonly 500: components["responses"]["internal_error"]; }; }; readonly "dependabot/list-alerts-for-enterprise": { @@ -87697,9 +88794,7 @@ export interface operations { readonly query?: { /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ readonly state?: components["parameters"]["secret-scanning-alert-state"]; - /** @description A comma-separated list of secret types to return. By default all secret types are returned. - * See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" - * for a complete list of secret types. */ + /** @description A comma-separated list of secret types to return. All default secret patterns are returned. To return experimental patterns, pass the token name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. */ readonly secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ readonly resolution?: components["parameters"]["secret-scanning-alert-resolution"]; @@ -87743,82 +88838,6 @@ export interface operations { readonly 503: components["responses"]["service_unavailable"]; }; }; - readonly "copilot/copilot-metrics-for-enterprise-team": { - readonly parameters: { - readonly query?: { - /** @description Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago. */ - readonly since?: string; - /** @description Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed. */ - readonly until?: string; - /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - readonly page?: components["parameters"]["page"]; - /** @description The number of days of metrics to display per page (max 28). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - readonly per_page?: number; - }; - readonly header?: never; - readonly path: { - /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - readonly enterprise: components["parameters"]["enterprise"]; - /** @description The slug of the enterprise team name. */ - readonly team_slug: components["parameters"]["enterprise-team-slug"]; - }; - readonly cookie?: never; - }; - readonly requestBody?: never; - readonly responses: { - /** @description Response */ - readonly 200: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": readonly components["schemas"]["copilot-usage-metrics-day"][]; - }; - }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["usage_metrics_api_disabled"]; - readonly 500: components["responses"]["internal_error"]; - }; - }; - readonly "copilot/usage-metrics-for-enterprise-team": { - readonly parameters: { - readonly query?: { - /** @description Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago. */ - readonly since?: string; - /** @description Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed. */ - readonly until?: string; - /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - readonly page?: components["parameters"]["page"]; - /** @description The number of days of metrics to display per page (max 28). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - readonly per_page?: number; - }; - readonly header?: never; - readonly path: { - /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - readonly enterprise: components["parameters"]["enterprise"]; - /** @description The slug of the team name. */ - readonly team_slug: components["parameters"]["team-slug"]; - }; - readonly cookie?: never; - }; - readonly requestBody?: never; - readonly responses: { - /** @description Response */ - readonly 200: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": readonly components["schemas"]["copilot-usage-metrics"][]; - }; - }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 500: components["responses"]["internal_error"]; - }; - }; readonly "activity/list-public-events": { readonly parameters: { readonly query?: { @@ -89271,6 +90290,34 @@ export interface operations { readonly 304: components["responses"]["not_modified"]; }; }; + readonly "billing/get-github-billing-usage-report-org": { + readonly parameters: { + readonly query?: { + /** @description If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2024`. Default value is the current year. */ + readonly year?: components["parameters"]["billing-usage-report-year"]; + /** @description If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. */ + readonly month?: components["parameters"]["billing-usage-report-month"]; + /** @description If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. */ + readonly day?: components["parameters"]["billing-usage-report-day"]; + /** @description If specified, only return results for a single hour. The value of `hour` is an integer between `0` and `23`. */ + readonly hour?: components["parameters"]["billing-usage-report-hour"]; + }; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + readonly 200: components["responses"]["billing_usage_report_org"]; + readonly 400: components["responses"]["bad_request"]; + readonly 403: components["responses"]["forbidden"]; + readonly 500: components["responses"]["internal_error"]; + readonly 503: components["responses"]["service_unavailable"]; + }; + }; readonly "orgs/get": { readonly parameters: { readonly query?: never; @@ -91166,6 +92213,7 @@ export interface operations { }; }; readonly repository_id?: number; + readonly bundle_url?: string; }[]; }; }; @@ -91421,6 +92469,7 @@ export interface operations { * @enum {string} */ readonly code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; + readonly code_scanning_default_setup_options?: components["schemas"]["code-scanning-default-setup-options"]; /** * @description The enablement status of secret scanning * @default disabled @@ -91646,6 +92695,7 @@ export interface operations { * @enum {string} */ readonly code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; + readonly code_scanning_default_setup_options?: components["schemas"]["code-scanning-default-setup-options"]; /** * @description The enablement status of secret scanning * @enum {string} @@ -93373,10 +94423,10 @@ export interface operations { readonly "api-insights/get-route-stats-by-actor": { readonly parameters: { readonly query: { - /** @description The minimum timestamp to query for stats */ + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ readonly min_timestamp: components["parameters"]["api-insights-min-timestamp"]; - /** @description The maximum timestamp to query for stats */ - readonly max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + readonly max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ readonly page?: components["parameters"]["page"]; /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ @@ -93385,6 +94435,8 @@ export interface operations { readonly direction?: components["parameters"]["direction"]; /** @description The property to sort the results by. */ readonly sort?: components["parameters"]["api-insights-route-stats-sort"]; + /** @description Providing a substring will filter results where the API route contains the substring. This is a case-insensitive search. */ + readonly api_route_substring?: components["parameters"]["api-insights-api-route-substring"]; }; readonly header?: never; readonly path: { @@ -93413,10 +94465,10 @@ export interface operations { readonly "api-insights/get-subject-stats": { readonly parameters: { readonly query: { - /** @description The minimum timestamp to query for stats */ + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ readonly min_timestamp: components["parameters"]["api-insights-min-timestamp"]; - /** @description The maximum timestamp to query for stats */ - readonly max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + readonly max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ readonly page?: components["parameters"]["page"]; /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ @@ -93425,6 +94477,8 @@ export interface operations { readonly direction?: components["parameters"]["direction"]; /** @description The property to sort the results by. */ readonly sort?: components["parameters"]["api-insights-sort"]; + /** @description Providing a substring will filter results where the subject name contains the substring. This is a case-insensitive search. */ + readonly subject_name_substring?: components["parameters"]["api-insights-subject-name-substring"]; }; readonly header?: never; readonly path: { @@ -93449,10 +94503,10 @@ export interface operations { readonly "api-insights/get-summary-stats": { readonly parameters: { readonly query: { - /** @description The minimum timestamp to query for stats */ + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ readonly min_timestamp: components["parameters"]["api-insights-min-timestamp"]; - /** @description The maximum timestamp to query for stats */ - readonly max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + readonly max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; }; readonly header?: never; readonly path: { @@ -93477,10 +94531,10 @@ export interface operations { readonly "api-insights/get-summary-stats-by-user": { readonly parameters: { readonly query: { - /** @description The minimum timestamp to query for stats */ + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ readonly min_timestamp: components["parameters"]["api-insights-min-timestamp"]; - /** @description The maximum timestamp to query for stats */ - readonly max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + readonly max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; }; readonly header?: never; readonly path: { @@ -93507,10 +94561,10 @@ export interface operations { readonly "api-insights/get-summary-stats-by-actor": { readonly parameters: { readonly query: { - /** @description The minimum timestamp to query for stats */ + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ readonly min_timestamp: components["parameters"]["api-insights-min-timestamp"]; - /** @description The maximum timestamp to query for stats */ - readonly max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + readonly max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; }; readonly header?: never; readonly path: { @@ -93539,10 +94593,10 @@ export interface operations { readonly "api-insights/get-time-stats": { readonly parameters: { readonly query: { - /** @description The minimum timestamp to query for stats */ + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ readonly min_timestamp: components["parameters"]["api-insights-min-timestamp"]; - /** @description The maximum timestamp to query for stats */ - readonly max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + readonly max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; /** @description The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) */ readonly timestamp_increment: components["parameters"]["api-insights-timestamp-increment"]; }; @@ -93569,10 +94623,10 @@ export interface operations { readonly "api-insights/get-time-stats-by-user": { readonly parameters: { readonly query: { - /** @description The minimum timestamp to query for stats */ + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ readonly min_timestamp: components["parameters"]["api-insights-min-timestamp"]; - /** @description The maximum timestamp to query for stats */ - readonly max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + readonly max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; /** @description The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) */ readonly timestamp_increment: components["parameters"]["api-insights-timestamp-increment"]; }; @@ -93601,10 +94655,10 @@ export interface operations { readonly "api-insights/get-time-stats-by-actor": { readonly parameters: { readonly query: { - /** @description The minimum timestamp to query for stats */ + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ readonly min_timestamp: components["parameters"]["api-insights-min-timestamp"]; - /** @description The maximum timestamp to query for stats */ - readonly max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + readonly max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; /** @description The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) */ readonly timestamp_increment: components["parameters"]["api-insights-timestamp-increment"]; }; @@ -93635,10 +94689,10 @@ export interface operations { readonly "api-insights/get-user-stats": { readonly parameters: { readonly query: { - /** @description The minimum timestamp to query for stats */ + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ readonly min_timestamp: components["parameters"]["api-insights-min-timestamp"]; - /** @description The maximum timestamp to query for stats */ - readonly max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + readonly max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ readonly page?: components["parameters"]["page"]; /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ @@ -93647,6 +94701,8 @@ export interface operations { readonly direction?: components["parameters"]["direction"]; /** @description The property to sort the results by. */ readonly sort?: components["parameters"]["api-insights-sort"]; + /** @description Providing a substring will filter results where the actor name contains the substring. This is a case-insensitive search. */ + readonly actor_name_substring?: components["parameters"]["api-insights-actor-name-substring"]; }; readonly header?: never; readonly path: { @@ -95515,6 +96571,223 @@ export interface operations { readonly 500: components["responses"]["internal_error"]; }; }; + readonly "private-registries/list-org-private-registries": { + readonly parameters: { + readonly query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly page?: components["parameters"]["page"]; + }; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly Link: components["headers"]["link"]; + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + readonly total_count: number; + readonly configurations: readonly components["schemas"]["org-private-registry-configuration"][]; + }; + }; + }; + readonly 400: components["responses"]["bad_request"]; + readonly 404: components["responses"]["not_found"]; + }; + }; + readonly "private-registries/create-org-private-registry": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + }; + readonly cookie?: never; + }; + readonly requestBody: { + readonly content: { + readonly "application/json": { + /** + * @description The registry type. + * @enum {string} + */ + readonly registry_type: "maven_repository"; + /** @description The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication. */ + readonly username?: string | null; + /** @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint. */ + readonly encrypted_value: string; + /** @description The ID of the key you used to encrypt the secret. */ + readonly key_id: string; + /** + * @description Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry. + * @enum {string} + */ + readonly visibility: "all" | "private" | "selected"; + /** @description An array of repository IDs that can access the organization private registry. You can only provide a list of repository IDs when `visibility` is set to `selected`. You can manage the list of selected repositories using the [Update a private registry for an organization](https://docs.github.com/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization) endpoint. This field should be omitted if `visibility` is set to `all` or `private`. */ + readonly selected_repository_ids?: readonly number[]; + }; + }; + }; + readonly responses: { + /** @description The organization private registry configuration */ + readonly 201: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["org-private-registry-configuration-with-selected-repositories"]; + }; + }; + readonly 404: components["responses"]["not_found"]; + readonly 422: components["responses"]["validation_failed"]; + }; + }; + readonly "private-registries/get-org-public-key": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly Link: components["headers"]["link"]; + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** + * @description The identifier for the key. + * @example 012345678912345678 + */ + readonly key_id: string; + /** + * @description The Base64 encoded public key. + * @example 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 + */ + readonly key: string; + }; + }; + }; + readonly 404: components["responses"]["not_found"]; + }; + }; + readonly "private-registries/get-org-private-registry": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + /** @description The name of the secret. */ + readonly secret_name: components["parameters"]["secret-name"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description The specified private registry configuration for the organization */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["org-private-registry-configuration"]; + }; + }; + readonly 404: components["responses"]["not_found"]; + }; + }; + readonly "private-registries/delete-org-private-registry": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + /** @description The name of the secret. */ + readonly secret_name: components["parameters"]["secret-name"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 204: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + readonly 400: components["responses"]["bad_request"]; + readonly 404: components["responses"]["not_found"]; + }; + }; + readonly "private-registries/update-org-private-registry": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + /** @description The name of the secret. */ + readonly secret_name: components["parameters"]["secret-name"]; + }; + readonly cookie?: never; + }; + readonly requestBody: { + readonly content: { + readonly "application/json": { + /** + * @description The registry type. + * @enum {string} + */ + readonly registry_type?: "maven_repository"; + /** @description The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication. */ + readonly username?: string | null; + /** @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint. */ + readonly encrypted_value?: string; + /** @description The ID of the key you used to encrypt the secret. */ + readonly key_id?: string; + /** + * @description Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry. + * @enum {string} + */ + readonly visibility?: "all" | "private" | "selected"; + /** @description An array of repository IDs that can access the organization private registry. You can only provide a list of repository IDs when `visibility` is set to `selected`. This field should be omitted if `visibility` is set to `all` or `private`. */ + readonly selected_repository_ids?: readonly number[]; + }; + }; + }; + readonly responses: { + /** @description Response */ + readonly 204: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + readonly 404: components["responses"]["not_found"]; + readonly 422: components["responses"]["validation_failed"]; + }; + }; readonly "projects/list-for-org": { readonly parameters: { readonly query?: { @@ -95682,23 +96955,7 @@ export interface operations { }; readonly requestBody: { readonly content: { - readonly "application/json": { - /** - * @description The type of the value for the property - * @example single_select - * @enum {string} - */ - readonly value_type: "string" | "single_select" | "multi_select" | "true_false"; - /** @description Whether the property is required. */ - readonly required?: boolean; - /** @description Default value of the property */ - readonly default_value?: (string | readonly string[]) | null; - /** @description Short description of the property */ - readonly description?: string | null; - /** @description An ordered list of the allowed values of the property. - * The property can have up to 200 allowed values. */ - readonly allowed_values?: readonly string[] | null; - }; + readonly "application/json": components["schemas"]["custom-property-set-payload"]; }; }; readonly responses: { @@ -96155,7 +97412,7 @@ export interface operations { * @default branch * @enum {string} */ - readonly target?: "branch" | "tag" | "push"; + readonly target?: "branch" | "tag" | "push" | "repository"; readonly enforcement: components["schemas"]["repository-rule-enforcement"]; /** @description The actors that can bypass the rules in this ruleset */ readonly bypass_actors?: readonly components["schemas"]["repository-ruleset-bypass-actor"][]; @@ -96184,7 +97441,7 @@ export interface operations { readonly query?: { /** @description The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. */ readonly ref?: components["parameters"]["ref-in-query"]; - /** @description The name of the repository to filter on. When specified, only rule evaluations from this repository will be returned. */ + /** @description The name of the repository to filter on. */ readonly repository_name?: components["parameters"]["repository-name-in-query"]; /** @description The time period to filter by. * @@ -96300,7 +97557,7 @@ export interface operations { * @description The target of the ruleset * @enum {string} */ - readonly target?: "branch" | "tag" | "push"; + readonly target?: "branch" | "tag" | "push" | "repository"; readonly enforcement?: components["schemas"]["repository-rule-enforcement"]; /** @description The actors that can bypass the rules in this ruleset */ readonly bypass_actors?: readonly components["schemas"]["repository-ruleset-bypass-actor"][]; @@ -96354,9 +97611,7 @@ export interface operations { readonly query?: { /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ readonly state?: components["parameters"]["secret-scanning-alert-state"]; - /** @description A comma-separated list of secret types to return. By default all secret types are returned. - * See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" - * for a complete list of secret types. */ + /** @description A comma-separated list of secret types to return. All default secret patterns are returned. To return experimental patterns, pass the token name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. */ readonly secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ readonly resolution?: components["parameters"]["secret-scanning-alert-resolution"]; @@ -101375,6 +102630,7 @@ export interface operations { }; }; readonly repository_id?: number; + readonly bundle_url?: string; }[]; }; }; @@ -103463,6 +104719,126 @@ export interface operations { readonly 503: components["responses"]["service_unavailable"]; }; }; + readonly "code-scanning/get-autofix": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The account owner of the repository. The name is not case sensitive. */ + readonly owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ + readonly repo: components["parameters"]["repo"]; + /** @description The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */ + readonly alert_number: components["parameters"]["alert-number"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["code-scanning-autofix"]; + }; + }; + readonly 400: components["responses"]["code_scanning_bad_request"]; + readonly 403: components["responses"]["code_scanning_forbidden_read"]; + readonly 404: components["responses"]["not_found"]; + readonly 503: components["responses"]["service_unavailable"]; + }; + }; + readonly "code-scanning/create-autofix": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The account owner of the repository. The name is not case sensitive. */ + readonly owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ + readonly repo: components["parameters"]["repo"]; + /** @description The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */ + readonly alert_number: components["parameters"]["alert-number"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description OK */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["code-scanning-autofix"]; + }; + }; + /** @description Accepted */ + readonly 202: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["code-scanning-autofix"]; + }; + }; + readonly 400: components["responses"]["code_scanning_bad_request"]; + readonly 403: components["responses"]["code_scanning_autofix_create_forbidden"]; + readonly 404: components["responses"]["not_found"]; + /** @description Unprocessable Entity */ + readonly 422: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + readonly 503: components["responses"]["service_unavailable"]; + }; + }; + readonly "code-scanning/commit-autofix": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The account owner of the repository. The name is not case sensitive. */ + readonly owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ + readonly repo: components["parameters"]["repo"]; + /** @description The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */ + readonly alert_number: components["parameters"]["alert-number"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: { + readonly content: { + readonly "application/json": components["schemas"]["code-scanning-autofix-commits"]; + }; + }; + readonly responses: { + /** @description Created */ + readonly 201: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["code-scanning-autofix-commits-response"]; + }; + }; + readonly 400: components["responses"]["code_scanning_bad_request"]; + readonly 403: components["responses"]["code_scanning_forbidden_write"]; + readonly 404: components["responses"]["not_found"]; + /** @description Unprocessable Entity */ + readonly 422: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + readonly 503: components["responses"]["service_unavailable"]; + }; + }; readonly "code-scanning/list-alert-instances": { readonly parameters: { readonly query?: { @@ -109679,6 +111055,163 @@ export interface operations { }; }; }; + readonly "issues/remove-sub-issue": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The account owner of the repository. The name is not case sensitive. */ + readonly owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ + readonly repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ + readonly issue_number: components["parameters"]["issue-number"]; + }; + readonly cookie?: never; + }; + readonly requestBody: { + readonly content: { + readonly "application/json": { + /** @description The sub-issue to remove */ + readonly sub_issue_id: number; + }; + }; + }; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + /** @example https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue */ + readonly Location?: string; + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["issue"]; + }; + }; + readonly 400: components["responses"]["bad_request"]; + readonly 404: components["responses"]["not_found"]; + }; + }; + readonly "issues/list-sub-issues": { + readonly parameters: { + readonly query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly page?: components["parameters"]["page"]; + }; + readonly header?: never; + readonly path: { + /** @description The account owner of the repository. The name is not case sensitive. */ + readonly owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ + readonly repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ + readonly issue_number: components["parameters"]["issue-number"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly Link: components["headers"]["link"]; + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": readonly components["schemas"]["issue"][]; + }; + }; + readonly 404: components["responses"]["not_found"]; + readonly 410: components["responses"]["gone"]; + }; + }; + readonly "issues/add-sub-issue": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The account owner of the repository. The name is not case sensitive. */ + readonly owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ + readonly repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ + readonly issue_number: components["parameters"]["issue-number"]; + }; + readonly cookie?: never; + }; + readonly requestBody: { + readonly content: { + readonly "application/json": { + /** @description The sub-issue to add */ + readonly sub_issue_id: number; + /** @description Option that, when true, instructs the operation to replace the sub-issues current parent issue */ + readonly replace_parent?: boolean; + }; + }; + }; + readonly responses: { + /** @description Response */ + readonly 201: { + headers: { + /** @example https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1 */ + readonly Location?: string; + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["issue"]; + }; + }; + readonly 403: components["responses"]["forbidden"]; + readonly 404: components["responses"]["not_found"]; + readonly 410: components["responses"]["gone"]; + readonly 422: components["responses"]["validation_failed"]; + }; + }; + readonly "issues/reprioritize-sub-issue": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The account owner of the repository. The name is not case sensitive. */ + readonly owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ + readonly repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ + readonly issue_number: components["parameters"]["issue-number"]; + }; + readonly cookie?: never; + }; + readonly requestBody: { + readonly content: { + readonly "application/json": { + /** @description The id of the sub-issue to reprioritize */ + readonly sub_issue_id: number; + /** @description The id of the sub-issue to be prioritized after (either positional argument after OR before should be specified). */ + readonly after_id?: number; + /** @description The id of the sub-issue to be prioritized before (either positional argument after OR before should be specified). */ + readonly before_id?: number; + }; + }; + }; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["issue"]; + }; + }; + readonly 403: components["responses"]["forbidden"]; + readonly 404: components["responses"]["not_found"]; + readonly 422: components["responses"]["validation_failed_simple"]; + readonly 503: components["responses"]["service_unavailable"]; + }; + }; readonly "issues/list-events-for-timeline": { readonly parameters: { readonly query?: { @@ -113291,9 +114824,7 @@ export interface operations { readonly query?: { /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ readonly state?: components["parameters"]["secret-scanning-alert-state"]; - /** @description A comma-separated list of secret types to return. By default all secret types are returned. - * See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" - * for a complete list of secret types. */ + /** @description A comma-separated list of secret types to return. All default secret patterns are returned. To return experimental patterns, pass the token name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. */ readonly secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ readonly resolution?: components["parameters"]["secret-scanning-alert-resolution"]; @@ -113534,6 +115065,39 @@ export interface operations { readonly 503: components["responses"]["service_unavailable"]; }; }; + readonly "secret-scanning/get-scan-history": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The account owner of the repository. The name is not case sensitive. */ + readonly owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ + readonly repo: components["parameters"]["repo"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["secret-scanning-scan-history"]; + }; + }; + /** @description Repository does not have GitHub Advanced Security or secret scanning enabled */ + readonly 404: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + readonly 503: components["responses"]["service_unavailable"]; + }; + }; readonly "security-advisories/list-repository-advisories": { readonly parameters: { readonly query?: { @@ -119189,6 +120753,7 @@ export interface operations { readonly attestations?: readonly { readonly bundle?: components["schemas"]["sigstore-bundle-0"]; readonly repository_id?: number; + readonly bundle_url?: string; }[]; }; }; diff --git a/packages/openapi-typescript/examples/github-api-immutable.ts b/packages/openapi-typescript/examples/github-api-immutable.ts index 5ac7b0e87..7591232fb 100644 --- a/packages/openapi-typescript/examples/github-api-immutable.ts +++ b/packages/openapi-typescript/examples/github-api-immutable.ts @@ -289,8 +289,6 @@ export interface paths { * * Optionally, use the `permissions` body parameter to specify the permissions that the installation access token should have. If `permissions` is not specified, the installation access token will have all of the permissions that were granted to the app. The installation access token cannot be granted permissions that the app was not granted. * - * When using the repository or permission parameters to reduce the access of the token, the complexity of the token is increased due to both the number of permissions in the request and the number of repositories the token will have access to. If the complexity is too large, the token will fail to be issued. If this occurs, the error message will indicate the maximum number of repositories that should be requested. For the average application requesting 8 permissions, this limit is around 5000 repositories. With fewer permissions requested, more repositories are supported. - * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ readonly post: operations["apps/create-installation-access-token"]; @@ -602,7 +600,7 @@ export interface paths { readonly patch?: never; readonly trace?: never; }; - readonly "/enterprises/{enterprise}/copilot/billing/seats": { + readonly "/enterprises/{enterprise}/code-security/configurations": { readonly parameters: { readonly query?: never; readonly header?: never; @@ -610,33 +608,31 @@ export interface paths { readonly cookie?: never; }; /** - * List all Copilot seat assignments for an enterprise - * @description > [!NOTE] - * > This endpoint is in public preview and is subject to change. + * Get code security configurations for an enterprise + * @description Lists all code security configurations available in an enterprise. * - * Lists all Copilot seats currently being billed for across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription. + * The authenticated user must be an administrator of the enterprise in order to use this endpoint. * - * Users with access through multiple organizations or enterprise teams will only be counted toward `total_seats` once. - * - * For each organization or enterprise team which grants Copilot access to a user, a seat detail object will appear in the `seats` array. - * Each seat object contains information about the assigned user's most recent Copilot activity. Users must have - * telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. For more information about activity data, - * see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." + * OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. + */ + readonly get: operations["code-security/get-configurations-for-enterprise"]; + readonly put?: never; + /** + * Create a code security configuration for an enterprise + * @description Creates a code security configuration in an enterprise. * - * Only enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams. + * The authenticated user must be an administrator of the enterprise in order to use this endpoint. * - * Personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ - readonly get: operations["copilot/list-copilot-seats-for-enterprise"]; - readonly put?: never; - readonly post?: never; + readonly post: operations["code-security/create-configuration-for-enterprise"]; readonly delete?: never; readonly options?: never; readonly head?: never; readonly patch?: never; readonly trace?: never; }; - readonly "/enterprises/{enterprise}/copilot/metrics": { + readonly "/enterprises/{enterprise}/code-security/configurations/defaults": { readonly parameters: { readonly query?: never; readonly header?: never; @@ -644,19 +640,14 @@ export interface paths { readonly cookie?: never; }; /** - * Get Copilot metrics for an enterprise - * @description Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. - * - * The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, - * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, - * they must have telemetry enabled in their IDE. + * Get default code security configurations for an enterprise + * @description Lists the default code security configurations for an enterprise. * - * To access this endpoint, the Copilot Metrics API access policy must be enabled or set to "no policy" for the enterprise within GitHub settings. - * Only enterprise owners and billing managers can view Copilot metrics for the enterprise. + * The authenticated user must be an administrator of the enterprise in order to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. */ - readonly get: operations["copilot/copilot-metrics-for-enterprise"]; + readonly get: operations["code-security/get-default-configurations-for-enterprise"]; readonly put?: never; readonly post?: never; readonly delete?: never; @@ -665,7 +656,7 @@ export interface paths { readonly patch?: never; readonly trace?: never; }; - readonly "/enterprises/{enterprise}/copilot/usage": { + readonly "/enterprises/{enterprise}/code-security/configurations/{configuration_id}": { readonly parameters: { readonly query?: never; readonly header?: never; @@ -673,52 +664,85 @@ export interface paths { readonly cookie?: never; }; /** - * Get a summary of Copilot usage for enterprise members - * @description > [!NOTE] - * > This endpoint is in public preview and is subject to change. + * Retrieve a code security configuration of an enterprise + * @description Gets a code security configuration available in an enterprise. * - * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE - * for all users across organizations with access to Copilot within your enterprise, with a further breakdown of suggestions, acceptances, - * and number of active users by editor and language for each day. See the response schema tab for detailed metrics definitions. + * The authenticated user must be an administrator of the enterprise in order to use this endpoint. * - * The response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day, - * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, - * they must have telemetry enabled in their IDE. + * OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. + */ + readonly get: operations["code-security/get-single-configuration-for-enterprise"]; + readonly put?: never; + readonly post?: never; + /** + * Delete a code security configuration for an enterprise + * @description Deletes a code security configuration from an enterprise. + * Repositories attached to the configuration will retain their settings but will no longer be associated with + * the configuration. + * + * The authenticated user must be an administrator for the enterprise to use this endpoint. * - * The time zone in the response is in UTC time, that means that the cutoff time for the "day" is UTC time. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + */ + readonly delete: operations["code-security/delete-configuration-for-enterprise"]; + readonly options?: never; + readonly head?: never; + /** + * Update a custom code security configuration for an enterprise + * @description Updates a code security configuration in an enterprise. * - * Only owners and billing managers can view Copilot usage metrics for the enterprise. + * The authenticated user must be an administrator of the enterprise in order to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ - readonly get: operations["copilot/usage-metrics-for-enterprise"]; + readonly patch: operations["code-security/update-enterprise-configuration"]; + readonly trace?: never; + }; + readonly "/enterprises/{enterprise}/code-security/configurations/{configuration_id}/attach": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + readonly get?: never; readonly put?: never; - readonly post?: never; + /** + * Attach an enterprise configuration to repositories + * @description Attaches an enterprise code security configuration to repositories. If the repositories specified are already attached to a configuration, they will be re-attached to the provided configuration. + * + * If insufficient GHAS licenses are available to attach the configuration to a repository, only free features will be enabled. + * + * The authenticated user must be an administrator for the enterprise to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + */ + readonly post: operations["code-security/attach-enterprise-configuration"]; readonly delete?: never; readonly options?: never; readonly head?: never; readonly patch?: never; readonly trace?: never; }; - readonly "/enterprises/{enterprise}/dependabot/alerts": { + readonly "/enterprises/{enterprise}/code-security/configurations/{configuration_id}/defaults": { readonly parameters: { readonly query?: never; readonly header?: never; readonly path?: never; readonly cookie?: never; }; + readonly get?: never; /** - * List Dependabot alerts for an enterprise - * @description Lists Dependabot alerts for repositories that are owned by the specified enterprise. + * Set a code security configuration as a default for an enterprise + * @description Sets a code security configuration as a default to be applied to new repositories in your enterprise. * - * The authenticated user must be a member of the enterprise to use this endpoint. + * This configuration will be applied by default to the matching repository type when created, but only for organizations within the enterprise that do not already have a default code security configuration set. * - * Alerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager. For more information about security managers, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * The authenticated user must be an administrator for the enterprise to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ - readonly get: operations["dependabot/list-alerts-for-enterprise"]; - readonly put?: never; + readonly put: operations["code-security/set-configuration-as-default-for-enterprise"]; readonly post?: never; readonly delete?: never; readonly options?: never; @@ -726,7 +750,7 @@ export interface paths { readonly patch?: never; readonly trace?: never; }; - readonly "/enterprises/{enterprise}/secret-scanning/alerts": { + readonly "/enterprises/{enterprise}/code-security/configurations/{configuration_id}/repositories": { readonly parameters: { readonly query?: never; readonly header?: never; @@ -734,16 +758,14 @@ export interface paths { readonly cookie?: never; }; /** - * List secret scanning alerts for an enterprise - * @description Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest. - * - * Alerts are only returned for organizations in the enterprise for which the authenticated user is an organization owner or a [security manager](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization). + * Get repositories associated with an enterprise code security configuration + * @description Lists the repositories associated with an enterprise code security configuration in an organization. * - * The authenticated user must be a member of the enterprise in order to use this endpoint. + * The authenticated user must be an administrator of the enterprise in order to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope or `security_events` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. */ - readonly get: operations["secret-scanning/list-alerts-for-enterprise"]; + readonly get: operations["code-security/get-repositories-for-enterprise-configuration"]; readonly put?: never; readonly post?: never; readonly delete?: never; @@ -752,7 +774,7 @@ export interface paths { readonly patch?: never; readonly trace?: never; }; - readonly "/enterprises/{enterprise}/team/{team_slug}/copilot/metrics": { + readonly "/enterprises/{enterprise}/dependabot/alerts": { readonly parameters: { readonly query?: never; readonly header?: never; @@ -760,22 +782,16 @@ export interface paths { readonly cookie?: never; }; /** - * Get Copilot metrics for an enterprise team - * @description Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. - * - * The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, - * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, - * they must have telemetry enabled in their IDE. + * List Dependabot alerts for an enterprise + * @description Lists Dependabot alerts for repositories that are owned by the specified enterprise. * - * > [!NOTE] - * > This endpoint will only return results for a given day if the enterprise team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day. + * The authenticated user must be a member of the enterprise to use this endpoint. * - * To access this endpoint, the Copilot Metrics API access policy must be enabled or set to "no policy" for the enterprise within GitHub settings. - * Only owners and billing managers for the enterprise that contains the enterprise team can view Copilot metrics for the enterprise team. + * Alerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager. For more information about security managers, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. */ - readonly get: operations["copilot/copilot-metrics-for-enterprise-team"]; + readonly get: operations["dependabot/list-alerts-for-enterprise"]; readonly put?: never; readonly post?: never; readonly delete?: never; @@ -784,7 +800,7 @@ export interface paths { readonly patch?: never; readonly trace?: never; }; - readonly "/enterprises/{enterprise}/team/{team_slug}/copilot/usage": { + readonly "/enterprises/{enterprise}/secret-scanning/alerts": { readonly parameters: { readonly query?: never; readonly header?: never; @@ -792,26 +808,16 @@ export interface paths { readonly cookie?: never; }; /** - * Get a summary of Copilot usage for an enterprise team - * @description > [!NOTE] - * > This endpoint is in public preview and is subject to change. - * - * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE - * for users within an enterprise team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day. - * See the response schema tab for detailed metrics definitions. - * - * The response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day, - * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, - * they must have telemetry enabled in their IDE. + * List secret scanning alerts for an enterprise + * @description Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest. * - * > [!NOTE] - * > This endpoint will only return results for a given day if the enterprise team had five or more members with active Copilot licenses, as evaluated at the end of that day. + * Alerts are only returned for organizations in the enterprise for which the authenticated user is an organization owner or a [security manager](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization). * - * Owners and billing managers for the enterprise that contains the enterprise team can view Copilot usage metrics for the enterprise team. + * The authenticated user must be a member of the enterprise in order to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope or `security_events` scope to use this endpoint. */ - readonly get: operations["copilot/usage-metrics-for-enterprise-team"]; + readonly get: operations["secret-scanning/list-alerts-for-enterprise"]; readonly put?: never; readonly post?: never; readonly delete?: never; @@ -1637,6 +1643,28 @@ export interface paths { readonly patch?: never; readonly trace?: never; }; + readonly "/organizations/{org}/settings/billing/usage": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Get billing usage report for an organization + * @description Gets a report of the total usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account. + * + * **Note:** This endpoint is only available to organizations with access to the enhanced billing platform. For more information, see "[About the enhanced billing platform](https://docs.github.com/billing/using-the-new-billing-platform)." + */ + readonly get: operations["billing/get-github-billing-usage-report-org"]; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; readonly "/orgs/{org}": { readonly parameters: { readonly query?: never; @@ -3217,13 +3245,11 @@ export interface paths { * Purchases a GitHub Copilot seat for all users within each specified team. * The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." * - * Only organization owners can add Copilot seats for their organization members. - * - * In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy. + * Only organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy. * For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." * For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." * - * The response will contain the total number of new seats that were created and existing seats that were refreshed. + * The response contains the total number of new seats that were created and existing seats that were refreshed. * * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. */ @@ -3235,14 +3261,11 @@ export interface paths { * * Sets seats for all members of each team specified to "pending cancellation". * This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team. - * - * For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." - * - * For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." + * For more information about disabling access to Copilot, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." * * Only organization owners can cancel Copilot seats for their organization members. * - * The response will contain the total number of seats set to "pending cancellation". + * The response contains the total number of seats set to "pending cancellation". * * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. */ @@ -3269,13 +3292,11 @@ export interface paths { * Purchases a GitHub Copilot seat for each user specified. * The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." * - * Only organization owners can add Copilot seats for their organization members. - * - * In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy. + * Only organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy. * For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." * For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." * - * The response will contain the total number of new seats that were created and existing seats that were refreshed. + * The response contains the total number of new seats that were created and existing seats that were refreshed. * * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. */ @@ -3287,14 +3308,11 @@ export interface paths { * * Sets seats for all users specified to "pending cancellation". * This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership. - * - * For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." - * - * For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." + * For more information about disabling access to Copilot, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." * * Only organization owners can cancel Copilot seats for their organization members. * - * The response will contain the total number of seats set to "pending cancellation". + * The response contains the total number of seats set to "pending cancellation". * * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. */ @@ -3609,7 +3627,9 @@ export interface paths { }; /** * List organization webhooks - * @description You must be an organization owner to use this endpoint. + * @description List webhooks for an organization. + * + * The authenticated user must be an organization owner to use this endpoint. * * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. @@ -3654,7 +3674,9 @@ export interface paths { readonly post?: never; /** * Delete an organization webhook - * @description You must be an organization owner to use this endpoint. + * @description Delete a webhook for an organization. + * + * The authenticated user must be an organization owner to use this endpoint. * * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. @@ -5027,6 +5049,109 @@ export interface paths { readonly patch?: never; readonly trace?: never; }; + readonly "/orgs/{org}/private-registries": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * List private registries for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Lists all private registry configurations available at the organization-level without revealing their encrypted + * values. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + readonly get: operations["private-registries/list-org-private-registries"]; + readonly put?: never; + /** + * Create a private registry for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Creates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + readonly post: operations["private-registries/create-org-private-registry"]; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; + readonly "/orgs/{org}/private-registries/public-key": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Get private registries public key for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Gets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets. + * + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + readonly get: operations["private-registries/get-org-public-key"]; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; + readonly "/orgs/{org}/private-registries/{secret_name}": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Get a private registry for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Get the configuration of a single private registry defined for an organization, omitting its encrypted value. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + readonly get: operations["private-registries/get-org-private-registry"]; + readonly put?: never; + readonly post?: never; + /** + * Delete a private registry for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Delete a private registry configuration at the organization-level. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + readonly delete: operations["private-registries/delete-org-private-registry"]; + readonly options?: never; + readonly head?: never; + /** + * Update a private registry for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + readonly patch: operations["private-registries/update-org-private-registry"]; + readonly trace?: never; + }; readonly "/orgs/{org}/projects": { readonly parameters: { readonly query?: never; @@ -5384,11 +5509,9 @@ export interface paths { }; /** * List security manager teams - * @description Lists teams that are security managers for an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." - * - * The authenticated user must be an administrator or security manager for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the "[Organization Roles](https://docs.github.com/rest/orgs/organization-roles)" endpoints instead. */ readonly get: operations["orgs/list-security-manager-teams"]; readonly put?: never; @@ -5409,21 +5532,17 @@ export interface paths { readonly get?: never; /** * Add a security manager team - * @description Adds a team as a security manager for an organization. For more information, see "[Managing security for an organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) for an organization." - * - * The authenticated user must be an administrator for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the "[Organization Roles](https://docs.github.com/rest/orgs/organization-roles)" endpoints instead. */ readonly put: operations["orgs/add-security-manager-team"]; readonly post?: never; /** * Remove a security manager team - * @description Removes the security manager role from a team for an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) team from an organization." - * - * The authenticated user must be an administrator for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the "[Organization Roles](https://docs.github.com/rest/orgs/organization-roles)" endpoints instead. */ readonly delete: operations["orgs/remove-security-manager-team"]; readonly options?: never; @@ -7166,7 +7285,7 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. * - * This API will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`. + * This endpoint will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`. */ readonly get: operations["actions/list-workflow-runs-for-repo"]; readonly put?: never; @@ -7871,6 +7990,8 @@ export interface paths { * Anyone with read access to the repository can use this endpoint * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * + * This endpoint will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`. */ readonly get: operations["actions/list-workflow-runs"]; readonly put?: never; @@ -8806,6 +8927,62 @@ export interface paths { readonly patch: operations["code-scanning/update-alert"]; readonly trace?: never; }; + readonly "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/autofix": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Get the status of an autofix for a code scanning alert + * @description Gets the status and description of an autofix for a code scanning alert. + * + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + */ + readonly get: operations["code-scanning/get-autofix"]; + readonly put?: never; + /** + * Create an autofix for a code scanning alert + * @description Creates an autofix for a code scanning alert. + * + * If a new autofix is to be created as a result of this request or is currently being generated, then this endpoint will return a 202 Accepted response. + * + * If an autofix already exists for a given alert, then this endpoint will return a 200 OK response. + * + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + */ + readonly post: operations["code-scanning/create-autofix"]; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; + readonly "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/autofix/commits": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + readonly get?: never; + readonly put?: never; + /** + * Commit an autofix for a code scanning alert + * @description Commits an autofix for a code scanning alert. + * + * If an autofix is commited as a result of this request, then this endpoint will return a 201 Created response. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + */ + readonly post: operations["code-scanning/commit-autofix"]; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; readonly "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances": { readonly parameters: { readonly query?: never; @@ -9700,6 +9877,7 @@ export interface paths { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -9842,6 +10020,7 @@ export interface paths { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -10042,6 +10221,7 @@ export interface paths { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -11026,6 +11206,7 @@ export interface paths { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -11075,6 +11256,7 @@ export interface paths { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -11220,6 +11402,7 @@ export interface paths { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -11265,6 +11448,7 @@ export interface paths { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -11381,7 +11565,12 @@ export interface paths { readonly get: operations["repos/get-webhook"]; readonly put?: never; readonly post?: never; - /** Delete a repository webhook */ + /** + * Delete a repository webhook + * @description Delete a webhook for an organization. + * + * The authenticated user must be a repository owner, or have admin access in the repository, to delete the webhook. + */ readonly delete: operations["repos/delete-webhook"]; readonly options?: never; readonly head?: never; @@ -12288,6 +12477,96 @@ export interface paths { readonly patch?: never; readonly trace?: never; }; + readonly "/repos/{owner}/{repo}/issues/{issue_number}/sub_issue": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + readonly get?: never; + readonly put?: never; + readonly post?: never; + /** + * Remove sub-issue + * @description You can use the REST API to remove a sub-issue from an issue. + * Removing content too quickly using this endpoint may result in secondary rate limiting. + * For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass a specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + */ + readonly delete: operations["issues/remove-sub-issue"]; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; + readonly "/repos/{owner}/{repo}/issues/{issue_number}/sub_issues": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * List sub-issues + * @description You can use the REST API to list the sub-issues on an issue. + * + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + */ + readonly get: operations["issues/list-sub-issues"]; + readonly put?: never; + /** + * Add sub-issue + * @description You can use the REST API to add sub-issues to issues. + * + * Creating content too quickly using this endpoint may result in secondary rate limiting. + * For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + * + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + */ + readonly post: operations["issues/add-sub-issue"]; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; + readonly "/repos/{owner}/{repo}/issues/{issue_number}/sub_issues/priority": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + readonly get?: never; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + /** + * Reprioritize sub-issue + * @description You can use the REST API to reprioritize a sub-issue to a different position in the parent list. + */ + readonly patch: operations["issues/reprioritize-sub-issue"]; + readonly trace?: never; + }; readonly "/repos/{owner}/{repo}/issues/{issue_number}/timeline": { readonly parameters: { readonly query?: never; @@ -13586,7 +13865,13 @@ export interface paths { }; /** * Get a release asset - * @description To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response. + * @description To download the asset's binary content: + * + * - If within a browser, fetch the location specified in the `browser_download_url` key provided in the response. + * - Alternatively, set the `Accept` header of the request to + * [`application/octet-stream`](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + * The API will either redirect the client to the location, or stream it directly if possible. + * API clients should handle both a `200` or `302` response. */ readonly get: operations["repos/get-release-asset"]; readonly put?: never; @@ -14005,6 +14290,28 @@ export interface paths { readonly patch?: never; readonly trace?: never; }; + readonly "/repos/{owner}/{repo}/secret-scanning/scan-history": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Get secret scanning scan history for a repository + * @description Lists the latest incremental and backfill scans by type for a repository. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + */ + readonly get: operations["secret-scanning/get-scan-history"]; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; readonly "/repos/{owner}/{repo}/security-advisories": { readonly parameters: { readonly query?: never; @@ -19792,394 +20099,396 @@ export interface components { /** Format: uri */ readonly html_url: string | null; }; - /** - * Organization Simple - * @description A GitHub organization. - */ - readonly "nullable-organization-simple": { - /** @example github */ - readonly login: string; - /** @example 1 */ - readonly id: number; - /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ - readonly node_id: string; + /** @description A code security configuration */ + readonly "code-security-configuration": { + /** @description The ID of the code security configuration */ + readonly id?: number; + /** @description The name of the code security configuration. Must be unique within the organization. */ + readonly name?: string; /** - * Format: uri - * @example https://api.github.com/orgs/github + * @description The type of the code security configuration. + * @enum {string} */ - readonly url: string; + readonly target_type?: "global" | "organization" | "enterprise"; + /** @description A description of the code security configuration */ + readonly description?: string; + /** + * @description The enablement status of GitHub Advanced Security + * @enum {string} + */ + readonly advanced_security?: "enabled" | "disabled"; + /** + * @description The enablement status of Dependency Graph + * @enum {string} + */ + readonly dependency_graph?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Automatic dependency submission + * @enum {string} + */ + readonly dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for Automatic dependency submission */ + readonly dependency_graph_autosubmit_action_options?: { + /** @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. */ + readonly labeled_runners?: boolean; + }; + /** + * @description The enablement status of Dependabot alerts + * @enum {string} + */ + readonly dependabot_alerts?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot security updates + * @enum {string} + */ + readonly dependabot_security_updates?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of code scanning default setup + * @enum {string} + */ + readonly code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for code scanning default setup */ + readonly code_scanning_default_setup_options?: { + /** + * @description Whether to use labeled runners or standard GitHub runners. + * @enum {string|null} + */ + readonly runner_type?: "standard" | "labeled" | "not_set" | null; + /** @description The label of the runner to use for code scanning when runner_type is 'labeled'. */ + readonly runner_label?: string | null; + } | null; + /** + * @description The enablement status of secret scanning + * @enum {string} + */ + readonly secret_scanning?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning push protection + * @enum {string} + */ + readonly secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning delegated bypass + * @enum {string} + */ + readonly secret_scanning_delegated_bypass?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for secret scanning delegated bypass */ + readonly secret_scanning_delegated_bypass_options?: { + /** @description The bypass reviewers for secret scanning delegated bypass */ + readonly reviewers?: readonly { + /** @description The ID of the team or role selected as a bypass reviewer */ + readonly reviewer_id: number; + /** + * @description The type of the bypass reviewer + * @enum {string} + */ + readonly reviewer_type: "TEAM" | "ROLE"; + }[]; + }; + /** + * @description The enablement status of secret scanning validity checks + * @enum {string} + */ + readonly secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning non-provider patterns + * @enum {string} + */ + readonly secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of private vulnerability reporting + * @enum {string} + */ + readonly private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; + /** + * @description The enforcement status for a security configuration + * @enum {string} + */ + readonly enforcement?: "enforced" | "unenforced"; /** * Format: uri - * @example https://api.github.com/orgs/github/repos + * @description The URL of the configuration */ - readonly repos_url: string; + readonly url?: string; /** * Format: uri - * @example https://api.github.com/orgs/github/events + * @description The URL of the configuration */ - readonly events_url: string; - /** @example https://api.github.com/orgs/github/hooks */ - readonly hooks_url: string; - /** @example https://api.github.com/orgs/github/issues */ - readonly issues_url: string; - /** @example https://api.github.com/orgs/github/members{/member} */ - readonly members_url: string; - /** @example https://api.github.com/orgs/github/public_members{/member} */ - readonly public_members_url: string; - /** @example https://github.com/images/error/octocat_happy.gif */ - readonly avatar_url: string; - /** @example A great organization */ - readonly description: string | null; + readonly html_url?: string; + /** Format: date-time */ + readonly created_at?: string; + /** Format: date-time */ + readonly updated_at?: string; + }; + /** @description Feature options for code scanning default setup */ + readonly "code-scanning-default-setup-options": { + /** + * @description Whether to use labeled runners or standard GitHub runners. + * @enum {string} + */ + readonly runner_type?: "standard" | "labeled" | "not_set"; + /** @description The label of the runner to use for code scanning default setup when runner_type is 'labeled'. */ + readonly runner_label?: string | null; } | null; + /** @description A list of default code security configurations */ + readonly "code-security-default-configurations": readonly { + /** + * @description The visibility of newly created repositories for which the code security configuration will be applied to by default + * @enum {unknown} + */ + readonly default_for_new_repos?: "public" | "private_and_internal" | "all"; + readonly configuration?: components["schemas"]["code-security-configuration"]; + }[]; /** - * Team Simple - * @description Groups of organization members that gives permissions on specified repositories. + * Simple Repository + * @description A GitHub repository. */ - readonly "nullable-team-simple": { + readonly "simple-repository": { /** - * @description Unique identifier of the team - * @example 1 + * Format: int64 + * @description A unique identifier of the repository. + * @example 1296269 */ readonly id: number; - /** @example MDQ6VGVhbTE= */ + /** + * @description The GraphQL identifier of the repository. + * @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + */ readonly node_id: string; + /** + * @description The name of the repository. + * @example Hello-World + */ + readonly name: string; + /** + * @description The full, globally unique, name of the repository. + * @example octocat/Hello-World + */ + readonly full_name: string; + readonly owner: components["schemas"]["simple-user"]; + /** @description Whether the repository is private. */ + readonly private: boolean; /** * Format: uri - * @description URL for the team - * @example https://api.github.com/organizations/1/team/1 + * @description The URL to view the repository on GitHub.com. + * @example https://github.com/octocat/Hello-World + */ + readonly html_url: string; + /** + * @description The repository description. + * @example This your first repo! + */ + readonly description: string | null; + /** @description Whether the repository is a fork. */ + readonly fork: boolean; + /** + * Format: uri + * @description The URL to get more information about the repository from the GitHub API. + * @example https://api.github.com/repos/octocat/Hello-World */ readonly url: string; - /** @example https://api.github.com/organizations/1/team/1/members{/member} */ - readonly members_url: string; /** - * @description Name of the team - * @example Justice League + * @description A template for the API URL to download the repository as an archive. + * @example https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ - readonly name: string; + readonly archive_url: string; /** - * @description Description of the team - * @example A great team. + * @description A template for the API URL to list the available assignees for issues in the repository. + * @example https://api.github.com/repos/octocat/Hello-World/assignees{/user} */ - readonly description: string | null; + readonly assignees_url: string; /** - * @description Permission that the team will have for its repositories - * @example admin + * @description A template for the API URL to create or retrieve a raw Git blob in the repository. + * @example https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} */ - readonly permission: string; + readonly blobs_url: string; /** - * @description The level of privacy this team should have - * @example closed + * @description A template for the API URL to get information about branches in the repository. + * @example https://api.github.com/repos/octocat/Hello-World/branches{/branch} */ - readonly privacy?: string; + readonly branches_url: string; /** - * @description The notification setting the team has set - * @example notifications_enabled + * @description A template for the API URL to get information about collaborators of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} */ - readonly notification_setting?: string; + readonly collaborators_url: string; + /** + * @description A template for the API URL to get information about comments on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/comments{/number} + */ + readonly comments_url: string; + /** + * @description A template for the API URL to get information about commits on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/commits{/sha} + */ + readonly commits_url: string; + /** + * @description A template for the API URL to compare two commits or refs. + * @example https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + */ + readonly compare_url: string; + /** + * @description A template for the API URL to get the contents of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/contents/{+path} + */ + readonly contents_url: string; /** * Format: uri - * @example https://github.com/orgs/rails/teams/core + * @description A template for the API URL to list the contributors to the repository. + * @example https://api.github.com/repos/octocat/Hello-World/contributors */ - readonly html_url: string; + readonly contributors_url: string; /** * Format: uri - * @example https://api.github.com/organizations/1/team/1/repos + * @description The API URL to list the deployments of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/deployments */ - readonly repositories_url: string; - /** @example justice-league */ - readonly slug: string; + readonly deployments_url: string; /** - * @description Distinguished Name (DN) that team maps to within LDAP environment - * @example uid=example,ou=users,dc=github,dc=com + * Format: uri + * @description The API URL to list the downloads on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/downloads */ - readonly ldap_dn?: string; - } | null; - /** - * Team - * @description Groups of organization members that gives permissions on specified repositories. - */ - readonly team: { - readonly id: number; - readonly node_id: string; - readonly name: string; - readonly slug: string; - readonly description: string | null; - readonly privacy?: string; - readonly notification_setting?: string; - readonly permission: string; - readonly permissions?: { - readonly pull: boolean; - readonly triage: boolean; - readonly push: boolean; - readonly maintain: boolean; - readonly admin: boolean; - }; - /** Format: uri */ - readonly url: string; + readonly downloads_url: string; /** * Format: uri - * @example https://github.com/orgs/rails/teams/core + * @description The API URL to list the events of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/events */ - readonly html_url: string; - readonly members_url: string; - /** Format: uri */ - readonly repositories_url: string; - readonly parent: components["schemas"]["nullable-team-simple"]; - }; - /** - * Enterprise Team - * @description Group of enterprise owners and/or members - */ - readonly "enterprise-team": { - /** Format: int64 */ - readonly id: number; - readonly name: string; - readonly slug: string; - /** Format: uri */ - readonly url: string; - /** @example disabled | all */ - readonly sync_to_organizations: string; - /** @example 62ab9291-fae2-468e-974b-7e45096d5021 */ - readonly group_id?: string | null; + readonly events_url: string; /** * Format: uri - * @example https://github.com/enterprises/dc/teams/justice-league + * @description The API URL to list the forks of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/forks */ - readonly html_url: string; - readonly members_url: string; - /** Format: date-time */ - readonly created_at: string; - /** Format: date-time */ - readonly updated_at: string; - }; - /** - * Copilot Business Seat Detail - * @description Information about a Copilot Business seat assignment for a user, team, or organization. - */ - readonly "copilot-seat-details": { - readonly assignee: components["schemas"]["simple-user"]; - readonly organization?: components["schemas"]["nullable-organization-simple"]; - /** @description The team through which the assignee is granted access to GitHub Copilot, if applicable. */ - readonly assigning_team?: (components["schemas"]["team"] | components["schemas"]["enterprise-team"]) | null; + readonly forks_url: string; /** - * Format: date - * @description The pending cancellation date for the seat, in `YYYY-MM-DD` format. This will be null unless the assignee's Copilot access has been canceled during the current billing cycle. If the seat has been cancelled, this corresponds to the start of the organization's next billing cycle. + * @description A template for the API URL to get information about Git commits of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ - readonly pending_cancellation_date?: string | null; + readonly git_commits_url: string; /** - * Format: date-time - * @description Timestamp of user's last GitHub Copilot activity, in ISO 8601 format. + * @description A template for the API URL to get information about Git refs of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} */ - readonly last_activity_at?: string | null; - /** @description Last editor that was used by the user for a GitHub Copilot completion. */ - readonly last_activity_editor?: string | null; + readonly git_refs_url: string; /** - * Format: date-time - * @description Timestamp of when the assignee was last granted access to GitHub Copilot, in ISO 8601 format. + * @description A template for the API URL to get information about Git tags of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} */ - readonly created_at: string; + readonly git_tags_url: string; /** - * Format: date-time - * @description Timestamp of when the assignee's GitHub Copilot access was last updated, in ISO 8601 format. + * @description A template for the API URL to get information about issue comments on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} */ - readonly updated_at?: string; + readonly issue_comment_url: string; /** - * @description The Copilot plan of the organization, or the parent enterprise, when applicable. - * @enum {string} + * @description A template for the API URL to get information about issue events on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/issues/events{/number} */ - readonly plan_type?: "business" | "enterprise" | "unknown"; - }; - /** @description Usage metrics for Copilot editor code completions in the IDE. */ - readonly "copilot-ide-code-completions": ({ - /** @description Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances. */ - readonly total_engaged_users?: number; - /** @description Code completion metrics for active languages. */ - readonly languages?: readonly { - /** @description Name of the language used for Copilot code completion suggestions. */ - readonly name?: string; - /** @description Number of users who accepted at least one Copilot code completion suggestion for the given language. Includes both full and partial acceptances. */ - readonly total_engaged_users?: number; - }[]; - readonly editors?: readonly ({ - /** @description Name of the given editor. */ - readonly name?: string; - /** @description Number of users who accepted at least one Copilot code completion suggestion for the given editor. Includes both full and partial acceptances. */ - readonly total_engaged_users?: number; - /** @description List of model metrics for custom models and the default model. */ - readonly models?: readonly { - /** @description Name of the language used for Copilot code completion suggestions, for the given editor. */ - readonly name?: string; - /** @description Indicates whether a model is custom or default. */ - readonly is_custom_model?: boolean; - /** @description The training date for the custom model. */ - readonly custom_model_training_date?: string | null; - /** @description Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances. */ - readonly total_engaged_users?: number; - /** @description Code completion metrics for active languages, for the given editor. */ - readonly languages?: readonly { - /** @description Name of the language used for Copilot code completion suggestions, for the given editor. */ - readonly name?: string; - /** @description Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language. Includes both full and partial acceptances. */ - readonly total_engaged_users?: number; - /** @description The number of Copilot code suggestions generated for the given editor, for the given language. */ - readonly total_code_suggestions?: number; - /** @description The number of Copilot code suggestions accepted for the given editor, for the given language. Includes both full and partial acceptances. */ - readonly total_code_acceptances?: number; - /** @description The number of lines of code suggested by Copilot code completions for the given editor, for the given language. */ - readonly total_code_lines_suggested?: number; - /** @description The number of lines of code accepted from Copilot code suggestions for the given editor, for the given language. */ - readonly total_code_lines_accepted?: number; - }[]; - }[]; - } & { - readonly [key: string]: unknown; - })[]; - } & { - readonly [key: string]: unknown; - }) | null; - /** @description Usage metrics for Copilot Chat in the IDE. */ - readonly "copilot-ide-chat": ({ - /** @description Total number of users who prompted Copilot Chat in the IDE. */ - readonly total_engaged_users?: number; - readonly editors?: readonly { - /** @description Name of the given editor. */ - readonly name?: string; - /** @description The number of users who prompted Copilot Chat in the specified editor. */ - readonly total_engaged_users?: number; - /** @description List of model metrics for custom models and the default model. */ - readonly models?: readonly { - /** @description Name of the language used for Copilot code completion suggestions, for the given editor. */ - readonly name?: string; - /** @description Indicates whether a model is custom or default. */ - readonly is_custom_model?: boolean; - /** @description The training date for the custom model. */ - readonly custom_model_training_date?: string | null; - /** @description The number of users who prompted Copilot Chat in the given editor and model. */ - readonly total_engaged_users?: number; - /** @description The total number of chats initiated by users in the given editor and model. */ - readonly total_chats?: number; - /** @description The number of times users accepted a code suggestion from Copilot Chat using the 'Insert Code' UI element, for the given editor. */ - readonly total_chat_insertion_events?: number; - /** @description The number of times users copied a code suggestion from Copilot Chat using the keyboard, or the 'Copy' UI element, for the given editor. */ - readonly total_chat_copy_events?: number; - }[]; - }[]; - } & { - readonly [key: string]: unknown; - }) | null; - /** @description Usage metrics for Copilot Chat in github.com */ - readonly "copilot-dotcom-chat": ({ - /** @description Total number of users who prompted Copilot Chat on github.com at least once. */ - readonly total_engaged_users?: number; - /** @description List of model metrics for a custom models and the default model. */ - readonly models?: readonly { - /** @description Name of the language used for Copilot code completion suggestions, for the given editor. */ - readonly name?: string; - /** @description Indicates whether a model is custom or default. */ - readonly is_custom_model?: boolean; - /** @description The training date for the custom model (if applicable). */ - readonly custom_model_training_date?: string | null; - /** @description Total number of users who prompted Copilot Chat on github.com at least once for each model. */ - readonly total_engaged_users?: number; - /** @description Total number of chats initiated by users on github.com. */ - readonly total_chats?: number; - }[]; - } & { - readonly [key: string]: unknown; - }) | null; - /** @description Usage metrics for Copilot for pull requests. */ - readonly "copilot-dotcom-pull-requests": ({ - /** @description The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once. */ - readonly total_engaged_users?: number; - /** @description Repositories in which users used Copilot for Pull Requests to generate pull request summaries */ - readonly repositories?: readonly { - /** @description Repository name */ - readonly name?: string; - /** @description The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository. */ - readonly total_engaged_users?: number; - /** @description List of model metrics for custom models and the default model. */ - readonly models?: readonly { - /** @description Name of the language used for Copilot code completion suggestions, for the given editor. */ - readonly name?: string; - /** @description Indicates whether a model is custom or default. */ - readonly is_custom_model?: boolean; - /** @description The training date for the custom model. */ - readonly custom_model_training_date?: string | null; - /** @description The number of pull request summaries generated using Copilot for Pull Requests in the given repository. */ - readonly total_pr_summaries_created?: number; - /** @description The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository and model. */ - readonly total_engaged_users?: number; - }[]; - }[]; - } & { - readonly [key: string]: unknown; - }) | null; - /** - * Copilot Usage Metrics - * @description Copilot usage metrics for a given day. - */ - readonly "copilot-usage-metrics-day": { + readonly issue_events_url: string; /** - * Format: date - * @description The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format. + * @description A template for the API URL to get information about issues on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/issues{/number} */ - readonly date: string; - /** @description The total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint. */ - readonly total_active_users?: number; - /** @description The total number of Copilot users who engaged with any Copilot feature, for the given day. Examples include but are not limited to accepting a code suggestion, prompting Copilot chat, or triggering a PR Summary. Does not include authentication events. Is not limited to the individual features detailed on the endpoint. */ - readonly total_engaged_users?: number; - readonly copilot_ide_code_completions?: components["schemas"]["copilot-ide-code-completions"]; - readonly copilot_ide_chat?: components["schemas"]["copilot-ide-chat"]; - readonly copilot_dotcom_chat?: components["schemas"]["copilot-dotcom-chat"]; - readonly copilot_dotcom_pull_requests?: components["schemas"]["copilot-dotcom-pull-requests"]; - } & { - readonly [key: string]: unknown; + readonly issues_url: string; + /** + * @description A template for the API URL to get information about deploy keys on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + */ + readonly keys_url: string; + /** + * @description A template for the API URL to get information about labels of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/labels{/name} + */ + readonly labels_url: string; + /** + * Format: uri + * @description The API URL to get information about the languages of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/languages + */ + readonly languages_url: string; + /** + * Format: uri + * @description The API URL to merge branches in the repository. + * @example https://api.github.com/repos/octocat/Hello-World/merges + */ + readonly merges_url: string; + /** + * @description A template for the API URL to get information about milestones of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/milestones{/number} + */ + readonly milestones_url: string; + /** + * @description A template for the API URL to get information about notifications on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + */ + readonly notifications_url: string; + /** + * @description A template for the API URL to get information about pull requests on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/pulls{/number} + */ + readonly pulls_url: string; + /** + * @description A template for the API URL to get information about releases on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/releases{/id} + */ + readonly releases_url: string; + /** + * Format: uri + * @description The API URL to list the stargazers on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/stargazers + */ + readonly stargazers_url: string; + /** + * @description A template for the API URL to get information about statuses of a commit. + * @example https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + */ + readonly statuses_url: string; + /** + * Format: uri + * @description The API URL to list the subscribers on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/subscribers + */ + readonly subscribers_url: string; + /** + * Format: uri + * @description The API URL to subscribe to notifications for this repository. + * @example https://api.github.com/repos/octocat/Hello-World/subscription + */ + readonly subscription_url: string; + /** + * Format: uri + * @description The API URL to get information about tags on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/tags + */ + readonly tags_url: string; + /** + * Format: uri + * @description The API URL to list the teams on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/teams + */ + readonly teams_url: string; + /** + * @description A template for the API URL to create or retrieve a raw Git tree of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + */ + readonly trees_url: string; + /** + * Format: uri + * @description The API URL to list the hooks on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/hooks + */ + readonly hooks_url: string; }; - /** - * Copilot Usage Metrics - * @description Summary of Copilot usage. - */ - readonly "copilot-usage-metrics": { + /** @description Repositories associated with a code security configuration and attachment status */ + readonly "code-security-configuration-repositories": { /** - * Format: date - * @description The date for which the usage metrics are reported, in `YYYY-MM-DD` format. + * @description The attachment status of the code security configuration on the repository. + * @enum {string} */ - readonly day: string; - /** @description The total number of Copilot code completion suggestions shown to users. */ - readonly total_suggestions_count?: number; - /** @description The total number of Copilot code completion suggestions accepted by users. */ - readonly total_acceptances_count?: number; - /** @description The total number of lines of code completions suggested by Copilot. */ - readonly total_lines_suggested?: number; - /** @description The total number of lines of code completions accepted by users. */ - readonly total_lines_accepted?: number; - /** @description The total number of users who were shown Copilot code completion suggestions during the day specified. */ - readonly total_active_users?: number; - /** @description The total instances of users who accepted code suggested by Copilot Chat in the IDE (panel and inline). */ - readonly total_chat_acceptances?: number; - /** @description The total number of chat turns (prompt and response pairs) sent between users and Copilot Chat in the IDE. */ - readonly total_chat_turns?: number; - /** @description The total number of users who interacted with Copilot Chat in the IDE during the day specified. */ - readonly total_active_chat_users?: number; - /** @description Breakdown of Copilot code completions usage by language and editor */ - readonly breakdown: readonly ({ - /** @description The language in which Copilot suggestions were shown to users in the specified editor. */ - readonly language?: string; - /** @description The editor in which Copilot suggestions were shown to users for the specified language. */ - readonly editor?: string; - /** @description The number of Copilot suggestions shown to users in the editor specified during the day specified. */ - readonly suggestions_count?: number; - /** @description The number of Copilot suggestions accepted by users in the editor specified during the day specified. */ - readonly acceptances_count?: number; - /** @description The number of lines of code suggested by Copilot in the editor specified during the day specified. */ - readonly lines_suggested?: number; - /** @description The number of lines of code accepted by users in the editor specified during the day specified. */ - readonly lines_accepted?: number; - /** @description The number of users who were shown Copilot completion suggestions in the editor specified during the day specified. */ - readonly active_users?: number; - } & { - readonly [key: string]: unknown; - })[] | null; + readonly status?: "attached" | "attaching" | "detached" | "removed" | "enforced" | "failed" | "updating" | "removed_by_enterprise"; + readonly repository?: components["schemas"]["simple-repository"]; }; /** @description The security alert number. */ readonly "alert-number": number; @@ -20307,248 +20616,6 @@ export interface components { * @description The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ readonly "alert-auto-dismissed-at": string | null; - /** - * Simple Repository - * @description A GitHub repository. - */ - readonly "simple-repository": { - /** - * Format: int64 - * @description A unique identifier of the repository. - * @example 1296269 - */ - readonly id: number; - /** - * @description The GraphQL identifier of the repository. - * @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - */ - readonly node_id: string; - /** - * @description The name of the repository. - * @example Hello-World - */ - readonly name: string; - /** - * @description The full, globally unique, name of the repository. - * @example octocat/Hello-World - */ - readonly full_name: string; - readonly owner: components["schemas"]["simple-user"]; - /** @description Whether the repository is private. */ - readonly private: boolean; - /** - * Format: uri - * @description The URL to view the repository on GitHub.com. - * @example https://github.com/octocat/Hello-World - */ - readonly html_url: string; - /** - * @description The repository description. - * @example This your first repo! - */ - readonly description: string | null; - /** @description Whether the repository is a fork. */ - readonly fork: boolean; - /** - * Format: uri - * @description The URL to get more information about the repository from the GitHub API. - * @example https://api.github.com/repos/octocat/Hello-World - */ - readonly url: string; - /** - * @description A template for the API URL to download the repository as an archive. - * @example https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - */ - readonly archive_url: string; - /** - * @description A template for the API URL to list the available assignees for issues in the repository. - * @example https://api.github.com/repos/octocat/Hello-World/assignees{/user} - */ - readonly assignees_url: string; - /** - * @description A template for the API URL to create or retrieve a raw Git blob in the repository. - * @example https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - */ - readonly blobs_url: string; - /** - * @description A template for the API URL to get information about branches in the repository. - * @example https://api.github.com/repos/octocat/Hello-World/branches{/branch} - */ - readonly branches_url: string; - /** - * @description A template for the API URL to get information about collaborators of the repository. - * @example https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - */ - readonly collaborators_url: string; - /** - * @description A template for the API URL to get information about comments on the repository. - * @example https://api.github.com/repos/octocat/Hello-World/comments{/number} - */ - readonly comments_url: string; - /** - * @description A template for the API URL to get information about commits on the repository. - * @example https://api.github.com/repos/octocat/Hello-World/commits{/sha} - */ - readonly commits_url: string; - /** - * @description A template for the API URL to compare two commits or refs. - * @example https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - */ - readonly compare_url: string; - /** - * @description A template for the API URL to get the contents of the repository. - * @example https://api.github.com/repos/octocat/Hello-World/contents/{+path} - */ - readonly contents_url: string; - /** - * Format: uri - * @description A template for the API URL to list the contributors to the repository. - * @example https://api.github.com/repos/octocat/Hello-World/contributors - */ - readonly contributors_url: string; - /** - * Format: uri - * @description The API URL to list the deployments of the repository. - * @example https://api.github.com/repos/octocat/Hello-World/deployments - */ - readonly deployments_url: string; - /** - * Format: uri - * @description The API URL to list the downloads on the repository. - * @example https://api.github.com/repos/octocat/Hello-World/downloads - */ - readonly downloads_url: string; - /** - * Format: uri - * @description The API URL to list the events of the repository. - * @example https://api.github.com/repos/octocat/Hello-World/events - */ - readonly events_url: string; - /** - * Format: uri - * @description The API URL to list the forks of the repository. - * @example https://api.github.com/repos/octocat/Hello-World/forks - */ - readonly forks_url: string; - /** - * @description A template for the API URL to get information about Git commits of the repository. - * @example https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - */ - readonly git_commits_url: string; - /** - * @description A template for the API URL to get information about Git refs of the repository. - * @example https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - */ - readonly git_refs_url: string; - /** - * @description A template for the API URL to get information about Git tags of the repository. - * @example https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - */ - readonly git_tags_url: string; - /** - * @description A template for the API URL to get information about issue comments on the repository. - * @example https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - */ - readonly issue_comment_url: string; - /** - * @description A template for the API URL to get information about issue events on the repository. - * @example https://api.github.com/repos/octocat/Hello-World/issues/events{/number} - */ - readonly issue_events_url: string; - /** - * @description A template for the API URL to get information about issues on the repository. - * @example https://api.github.com/repos/octocat/Hello-World/issues{/number} - */ - readonly issues_url: string; - /** - * @description A template for the API URL to get information about deploy keys on the repository. - * @example https://api.github.com/repos/octocat/Hello-World/keys{/key_id} - */ - readonly keys_url: string; - /** - * @description A template for the API URL to get information about labels of the repository. - * @example https://api.github.com/repos/octocat/Hello-World/labels{/name} - */ - readonly labels_url: string; - /** - * Format: uri - * @description The API URL to get information about the languages of the repository. - * @example https://api.github.com/repos/octocat/Hello-World/languages - */ - readonly languages_url: string; - /** - * Format: uri - * @description The API URL to merge branches in the repository. - * @example https://api.github.com/repos/octocat/Hello-World/merges - */ - readonly merges_url: string; - /** - * @description A template for the API URL to get information about milestones of the repository. - * @example https://api.github.com/repos/octocat/Hello-World/milestones{/number} - */ - readonly milestones_url: string; - /** - * @description A template for the API URL to get information about notifications on the repository. - * @example https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - */ - readonly notifications_url: string; - /** - * @description A template for the API URL to get information about pull requests on the repository. - * @example https://api.github.com/repos/octocat/Hello-World/pulls{/number} - */ - readonly pulls_url: string; - /** - * @description A template for the API URL to get information about releases on the repository. - * @example https://api.github.com/repos/octocat/Hello-World/releases{/id} - */ - readonly releases_url: string; - /** - * Format: uri - * @description The API URL to list the stargazers on the repository. - * @example https://api.github.com/repos/octocat/Hello-World/stargazers - */ - readonly stargazers_url: string; - /** - * @description A template for the API URL to get information about statuses of a commit. - * @example https://api.github.com/repos/octocat/Hello-World/statuses/{sha} - */ - readonly statuses_url: string; - /** - * Format: uri - * @description The API URL to list the subscribers on the repository. - * @example https://api.github.com/repos/octocat/Hello-World/subscribers - */ - readonly subscribers_url: string; - /** - * Format: uri - * @description The API URL to subscribe to notifications for this repository. - * @example https://api.github.com/repos/octocat/Hello-World/subscription - */ - readonly subscription_url: string; - /** - * Format: uri - * @description The API URL to get information about tags on the repository. - * @example https://api.github.com/repos/octocat/Hello-World/tags - */ - readonly tags_url: string; - /** - * Format: uri - * @description The API URL to list the teams on the repository. - * @example https://api.github.com/repos/octocat/Hello-World/teams - */ - readonly teams_url: string; - /** - * @description A template for the API URL to create or retrieve a raw Git tree of the repository. - * @example https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - */ - readonly trees_url: string; - /** - * Format: uri - * @description The API URL to list the hooks on the repository. - * @example https://api.github.com/repos/octocat/Hello-World/hooks - */ - readonly hooks_url: string; - }; /** @description A Dependabot alert. */ readonly "dependabot-alert-with-repository": { readonly number: components["schemas"]["alert-number"]; @@ -20637,6 +20704,16 @@ export interface components { * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ readonly push_protection_bypassed_at?: string | null; + readonly push_protection_bypass_request_reviewer?: components["schemas"]["nullable-simple-user"]; + /** @description An optional comment when reviewing a push protection bypass. */ + readonly push_protection_bypass_request_reviewer_comment?: string | null; + /** @description An optional comment when requesting a push protection bypass. */ + readonly push_protection_bypass_request_comment?: string | null; + /** + * Format: uri + * @description The URL to a push protection bypass request. + */ + readonly push_protection_bypass_request_html_url?: string | null; /** @description The comment that was optionally added when this alert was closed */ readonly resolution_comment?: string | null; /** @@ -20836,6 +20913,12 @@ export interface components { readonly eyes: number; readonly rocket: number; }; + /** Sub-issues Summary */ + readonly "sub-issues-summary": { + readonly total: number; + readonly completed: number; + readonly percent_completed: number; + }; /** * Issue * @description Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. @@ -20938,6 +21021,7 @@ export interface components { readonly performed_via_github_app?: components["schemas"]["nullable-integration"]; readonly author_association: components["schemas"]["author-association"]; readonly reactions?: components["schemas"]["reaction-rollup"]; + readonly sub_issues_summary?: components["schemas"]["sub-issues-summary"]; }; /** * Issue Comment @@ -21624,6 +21708,10 @@ export interface components { readonly copilot?: readonly string[]; readonly packages?: readonly string[]; readonly actions?: readonly string[]; + readonly actions_inbound?: { + readonly full_domains?: readonly string[]; + readonly wildcard_domains?: readonly string[]; + }; readonly artifact_attestations?: { /** @example [ * "example" @@ -21967,6 +22055,32 @@ export interface components { /** @example A great organization */ readonly description: string | null; }; + readonly "billing-usage-report": { + readonly usageItems?: readonly { + /** @description Date of the usage line item. */ + readonly date: string; + /** @description Product name. */ + readonly product: string; + /** @description SKU name. */ + readonly sku: string; + /** @description Quantity of the usage line item. */ + readonly quantity: number; + /** @description Unit type of the usage line item. */ + readonly unitType: string; + /** @description Price per unit of the usage line item. */ + readonly pricePerUnit: number; + /** @description Gross amount of the usage line item. */ + readonly grossAmount: number; + /** @description Discount amount of the usage line item. */ + readonly discountAmount: number; + /** @description Net amount of the usage line item. */ + readonly netAmount: number; + /** @description Name of the organization. */ + readonly organizationName: string; + /** @description Name of the repository. */ + readonly repositoryName?: string; + }[]; + }; /** * Organization Full * @description Organization Full @@ -22588,135 +22702,6 @@ export interface components { readonly most_recent_instance: components["schemas"]["code-scanning-alert-instance"]; readonly repository: components["schemas"]["simple-repository"]; }; - /** @description A code security configuration */ - readonly "code-security-configuration": { - /** @description The ID of the code security configuration */ - readonly id?: number; - /** @description The name of the code security configuration. Must be unique within the organization. */ - readonly name?: string; - /** - * @description The type of the code security configuration. - * @enum {string} - */ - readonly target_type?: "global" | "organization" | "enterprise"; - /** @description A description of the code security configuration */ - readonly description?: string; - /** - * @description The enablement status of GitHub Advanced Security - * @enum {string} - */ - readonly advanced_security?: "enabled" | "disabled"; - /** - * @description The enablement status of Dependency Graph - * @enum {string} - */ - readonly dependency_graph?: "enabled" | "disabled" | "not_set"; - /** - * @description The enablement status of Automatic dependency submission - * @enum {string} - */ - readonly dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"; - /** @description Feature options for Automatic dependency submission */ - readonly dependency_graph_autosubmit_action_options?: { - /** @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. */ - readonly labeled_runners?: boolean; - }; - /** - * @description The enablement status of Dependabot alerts - * @enum {string} - */ - readonly dependabot_alerts?: "enabled" | "disabled" | "not_set"; - /** - * @description The enablement status of Dependabot security updates - * @enum {string} - */ - readonly dependabot_security_updates?: "enabled" | "disabled" | "not_set"; - /** - * @description The enablement status of code scanning default setup - * @enum {string} - */ - readonly code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; - /** - * @description The enablement status of secret scanning - * @enum {string} - */ - readonly secret_scanning?: "enabled" | "disabled" | "not_set"; - /** - * @description The enablement status of secret scanning push protection - * @enum {string} - */ - readonly secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; - /** - * @description The enablement status of secret scanning delegated bypass - * @enum {string} - */ - readonly secret_scanning_delegated_bypass?: "enabled" | "disabled" | "not_set"; - /** @description Feature options for secret scanning delegated bypass */ - readonly secret_scanning_delegated_bypass_options?: { - /** @description The bypass reviewers for secret scanning delegated bypass */ - readonly reviewers?: readonly { - /** @description The ID of the team or role selected as a bypass reviewer */ - readonly reviewer_id: number; - /** - * @description The type of the bypass reviewer - * @enum {string} - */ - readonly reviewer_type: "TEAM" | "ROLE"; - }[]; - }; - /** - * @description The enablement status of secret scanning validity checks - * @enum {string} - */ - readonly secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; - /** - * @description The enablement status of secret scanning non-provider patterns - * @enum {string} - */ - readonly secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set"; - /** - * @description The enablement status of private vulnerability reporting - * @enum {string} - */ - readonly private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; - /** - * @description The enforcement status for a security configuration - * @enum {string} - */ - readonly enforcement?: "enforced" | "unenforced"; - /** - * Format: uri - * @description The URL of the configuration - */ - readonly url?: string; - /** - * Format: uri - * @description The URL of the configuration - */ - readonly html_url?: string; - /** Format: date-time */ - readonly created_at?: string; - /** Format: date-time */ - readonly updated_at?: string; - }; - /** @description A list of default code security configurations */ - readonly "code-security-default-configurations": readonly { - /** - * @description The visibility of newly created repositories for which the code security configuration will be applied to by default - * @enum {unknown} - */ - readonly default_for_new_repos?: "public" | "private_and_internal" | "all"; - readonly configuration?: components["schemas"]["code-security-configuration"]; - }[]; - /** @description Repositories associated with a code security configuration and attachment status */ - readonly "code-security-configuration-repositories": { - /** - * @description The attachment status of the code security configuration on the repository. - * @enum {string} - */ - readonly status?: "attached" | "attaching" | "detached" | "removed" | "enforced" | "failed" | "updating" | "removed_by_enterprise"; - readonly repository?: components["schemas"]["simple-repository"]; - }; /** * Codespace machine * @description A description of the machine powering a codespace. @@ -23029,6 +23014,396 @@ export interface components { } & { readonly [key: string]: unknown; }; + /** + * Organization Simple + * @description A GitHub organization. + */ + readonly "nullable-organization-simple": { + /** @example github */ + readonly login: string; + /** @example 1 */ + readonly id: number; + /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ + readonly node_id: string; + /** + * Format: uri + * @example https://api.github.com/orgs/github + */ + readonly url: string; + /** + * Format: uri + * @example https://api.github.com/orgs/github/repos + */ + readonly repos_url: string; + /** + * Format: uri + * @example https://api.github.com/orgs/github/events + */ + readonly events_url: string; + /** @example https://api.github.com/orgs/github/hooks */ + readonly hooks_url: string; + /** @example https://api.github.com/orgs/github/issues */ + readonly issues_url: string; + /** @example https://api.github.com/orgs/github/members{/member} */ + readonly members_url: string; + /** @example https://api.github.com/orgs/github/public_members{/member} */ + readonly public_members_url: string; + /** @example https://github.com/images/error/octocat_happy.gif */ + readonly avatar_url: string; + /** @example A great organization */ + readonly description: string | null; + } | null; + /** + * Team Simple + * @description Groups of organization members that gives permissions on specified repositories. + */ + readonly "nullable-team-simple": { + /** + * @description Unique identifier of the team + * @example 1 + */ + readonly id: number; + /** @example MDQ6VGVhbTE= */ + readonly node_id: string; + /** + * Format: uri + * @description URL for the team + * @example https://api.github.com/organizations/1/team/1 + */ + readonly url: string; + /** @example https://api.github.com/organizations/1/team/1/members{/member} */ + readonly members_url: string; + /** + * @description Name of the team + * @example Justice League + */ + readonly name: string; + /** + * @description Description of the team + * @example A great team. + */ + readonly description: string | null; + /** + * @description Permission that the team will have for its repositories + * @example admin + */ + readonly permission: string; + /** + * @description The level of privacy this team should have + * @example closed + */ + readonly privacy?: string; + /** + * @description The notification setting the team has set + * @example notifications_enabled + */ + readonly notification_setting?: string; + /** + * Format: uri + * @example https://github.com/orgs/rails/teams/core + */ + readonly html_url: string; + /** + * Format: uri + * @example https://api.github.com/organizations/1/team/1/repos + */ + readonly repositories_url: string; + /** @example justice-league */ + readonly slug: string; + /** + * @description Distinguished Name (DN) that team maps to within LDAP environment + * @example uid=example,ou=users,dc=github,dc=com + */ + readonly ldap_dn?: string; + } | null; + /** + * Team + * @description Groups of organization members that gives permissions on specified repositories. + */ + readonly team: { + readonly id: number; + readonly node_id: string; + readonly name: string; + readonly slug: string; + readonly description: string | null; + readonly privacy?: string; + readonly notification_setting?: string; + readonly permission: string; + readonly permissions?: { + readonly pull: boolean; + readonly triage: boolean; + readonly push: boolean; + readonly maintain: boolean; + readonly admin: boolean; + }; + /** Format: uri */ + readonly url: string; + /** + * Format: uri + * @example https://github.com/orgs/rails/teams/core + */ + readonly html_url: string; + readonly members_url: string; + /** Format: uri */ + readonly repositories_url: string; + readonly parent: components["schemas"]["nullable-team-simple"]; + }; + /** + * Enterprise Team + * @description Group of enterprise owners and/or members + */ + readonly "enterprise-team": { + /** Format: int64 */ + readonly id: number; + readonly name: string; + readonly slug: string; + /** Format: uri */ + readonly url: string; + /** @example disabled | all */ + readonly sync_to_organizations: string; + /** @example 62ab9291-fae2-468e-974b-7e45096d5021 */ + readonly group_id?: string | null; + /** + * Format: uri + * @example https://github.com/enterprises/dc/teams/justice-league + */ + readonly html_url: string; + readonly members_url: string; + /** Format: date-time */ + readonly created_at: string; + /** Format: date-time */ + readonly updated_at: string; + }; + /** + * Copilot Business Seat Detail + * @description Information about a Copilot Business seat assignment for a user, team, or organization. + */ + readonly "copilot-seat-details": { + readonly assignee: components["schemas"]["simple-user"]; + readonly organization?: components["schemas"]["nullable-organization-simple"]; + /** @description The team through which the assignee is granted access to GitHub Copilot, if applicable. */ + readonly assigning_team?: (components["schemas"]["team"] | components["schemas"]["enterprise-team"]) | null; + /** + * Format: date + * @description The pending cancellation date for the seat, in `YYYY-MM-DD` format. This will be null unless the assignee's Copilot access has been canceled during the current billing cycle. If the seat has been cancelled, this corresponds to the start of the organization's next billing cycle. + */ + readonly pending_cancellation_date?: string | null; + /** + * Format: date-time + * @description Timestamp of user's last GitHub Copilot activity, in ISO 8601 format. + */ + readonly last_activity_at?: string | null; + /** @description Last editor that was used by the user for a GitHub Copilot completion. */ + readonly last_activity_editor?: string | null; + /** + * Format: date-time + * @description Timestamp of when the assignee was last granted access to GitHub Copilot, in ISO 8601 format. + */ + readonly created_at: string; + /** + * Format: date-time + * @deprecated + * @description **Closing down notice:** This field is no longer relevant and is closing down. Use the `created_at` field to determine when the assignee was last granted access to GitHub Copilot. Timestamp of when the assignee's GitHub Copilot access was last updated, in ISO 8601 format. + */ + readonly updated_at?: string; + /** + * @description The Copilot plan of the organization, or the parent enterprise, when applicable. + * @enum {string} + */ + readonly plan_type?: "business" | "enterprise" | "unknown"; + }; + /** @description Usage metrics for Copilot editor code completions in the IDE. */ + readonly "copilot-ide-code-completions": ({ + /** @description Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances. */ + readonly total_engaged_users?: number; + /** @description Code completion metrics for active languages. */ + readonly languages?: readonly { + /** @description Name of the language used for Copilot code completion suggestions. */ + readonly name?: string; + /** @description Number of users who accepted at least one Copilot code completion suggestion for the given language. Includes both full and partial acceptances. */ + readonly total_engaged_users?: number; + }[]; + readonly editors?: readonly ({ + /** @description Name of the given editor. */ + readonly name?: string; + /** @description Number of users who accepted at least one Copilot code completion suggestion for the given editor. Includes both full and partial acceptances. */ + readonly total_engaged_users?: number; + /** @description List of model metrics for custom models and the default model. */ + readonly models?: readonly { + /** @description Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'. */ + readonly name?: string; + /** @description Indicates whether a model is custom or default. */ + readonly is_custom_model?: boolean; + /** @description The training date for the custom model. */ + readonly custom_model_training_date?: string | null; + /** @description Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances. */ + readonly total_engaged_users?: number; + /** @description Code completion metrics for active languages, for the given editor. */ + readonly languages?: readonly { + /** @description Name of the language used for Copilot code completion suggestions, for the given editor. */ + readonly name?: string; + /** @description Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language. Includes both full and partial acceptances. */ + readonly total_engaged_users?: number; + /** @description The number of Copilot code suggestions generated for the given editor, for the given language. */ + readonly total_code_suggestions?: number; + /** @description The number of Copilot code suggestions accepted for the given editor, for the given language. Includes both full and partial acceptances. */ + readonly total_code_acceptances?: number; + /** @description The number of lines of code suggested by Copilot code completions for the given editor, for the given language. */ + readonly total_code_lines_suggested?: number; + /** @description The number of lines of code accepted from Copilot code suggestions for the given editor, for the given language. */ + readonly total_code_lines_accepted?: number; + }[]; + }[]; + } & { + readonly [key: string]: unknown; + })[]; + } & { + readonly [key: string]: unknown; + }) | null; + /** @description Usage metrics for Copilot Chat in the IDE. */ + readonly "copilot-ide-chat": ({ + /** @description Total number of users who prompted Copilot Chat in the IDE. */ + readonly total_engaged_users?: number; + readonly editors?: readonly { + /** @description Name of the given editor. */ + readonly name?: string; + /** @description The number of users who prompted Copilot Chat in the specified editor. */ + readonly total_engaged_users?: number; + /** @description List of model metrics for custom models and the default model. */ + readonly models?: readonly { + /** @description Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'. */ + readonly name?: string; + /** @description Indicates whether a model is custom or default. */ + readonly is_custom_model?: boolean; + /** @description The training date for the custom model. */ + readonly custom_model_training_date?: string | null; + /** @description The number of users who prompted Copilot Chat in the given editor and model. */ + readonly total_engaged_users?: number; + /** @description The total number of chats initiated by users in the given editor and model. */ + readonly total_chats?: number; + /** @description The number of times users accepted a code suggestion from Copilot Chat using the 'Insert Code' UI element, for the given editor. */ + readonly total_chat_insertion_events?: number; + /** @description The number of times users copied a code suggestion from Copilot Chat using the keyboard, or the 'Copy' UI element, for the given editor. */ + readonly total_chat_copy_events?: number; + }[]; + }[]; + } & { + readonly [key: string]: unknown; + }) | null; + /** @description Usage metrics for Copilot Chat in github.com */ + readonly "copilot-dotcom-chat": ({ + /** @description Total number of users who prompted Copilot Chat on github.com at least once. */ + readonly total_engaged_users?: number; + /** @description List of model metrics for a custom models and the default model. */ + readonly models?: readonly { + /** @description Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'. */ + readonly name?: string; + /** @description Indicates whether a model is custom or default. */ + readonly is_custom_model?: boolean; + /** @description The training date for the custom model (if applicable). */ + readonly custom_model_training_date?: string | null; + /** @description Total number of users who prompted Copilot Chat on github.com at least once for each model. */ + readonly total_engaged_users?: number; + /** @description Total number of chats initiated by users on github.com. */ + readonly total_chats?: number; + }[]; + } & { + readonly [key: string]: unknown; + }) | null; + /** @description Usage metrics for Copilot for pull requests. */ + readonly "copilot-dotcom-pull-requests": ({ + /** @description The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once. */ + readonly total_engaged_users?: number; + /** @description Repositories in which users used Copilot for Pull Requests to generate pull request summaries */ + readonly repositories?: readonly { + /** @description Repository name */ + readonly name?: string; + /** @description The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository. */ + readonly total_engaged_users?: number; + /** @description List of model metrics for custom models and the default model. */ + readonly models?: readonly { + /** @description Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'. */ + readonly name?: string; + /** @description Indicates whether a model is custom or default. */ + readonly is_custom_model?: boolean; + /** @description The training date for the custom model. */ + readonly custom_model_training_date?: string | null; + /** @description The number of pull request summaries generated using Copilot for Pull Requests in the given repository. */ + readonly total_pr_summaries_created?: number; + /** @description The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository and model. */ + readonly total_engaged_users?: number; + }[]; + }[]; + } & { + readonly [key: string]: unknown; + }) | null; + /** + * Copilot Usage Metrics + * @description Copilot usage metrics for a given day. + */ + readonly "copilot-usage-metrics-day": { + /** + * Format: date + * @description The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format. + */ + readonly date: string; + /** @description The total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint. */ + readonly total_active_users?: number; + /** @description The total number of Copilot users who engaged with any Copilot feature, for the given day. Examples include but are not limited to accepting a code suggestion, prompting Copilot chat, or triggering a PR Summary. Does not include authentication events. Is not limited to the individual features detailed on the endpoint. */ + readonly total_engaged_users?: number; + readonly copilot_ide_code_completions?: components["schemas"]["copilot-ide-code-completions"]; + readonly copilot_ide_chat?: components["schemas"]["copilot-ide-chat"]; + readonly copilot_dotcom_chat?: components["schemas"]["copilot-dotcom-chat"]; + readonly copilot_dotcom_pull_requests?: components["schemas"]["copilot-dotcom-pull-requests"]; + } & { + readonly [key: string]: unknown; + }; + /** + * Copilot Usage Metrics + * @description Summary of Copilot usage. + */ + readonly "copilot-usage-metrics": { + /** + * Format: date + * @description The date for which the usage metrics are reported, in `YYYY-MM-DD` format. + */ + readonly day: string; + /** @description The total number of Copilot code completion suggestions shown to users. */ + readonly total_suggestions_count?: number; + /** @description The total number of Copilot code completion suggestions accepted by users. */ + readonly total_acceptances_count?: number; + /** @description The total number of lines of code completions suggested by Copilot. */ + readonly total_lines_suggested?: number; + /** @description The total number of lines of code completions accepted by users. */ + readonly total_lines_accepted?: number; + /** @description The total number of users who were shown Copilot code completion suggestions during the day specified. */ + readonly total_active_users?: number; + /** @description The total instances of users who accepted code suggested by Copilot Chat in the IDE (panel and inline). */ + readonly total_chat_acceptances?: number; + /** @description The total number of chat turns (prompt and response pairs) sent between users and Copilot Chat in the IDE. */ + readonly total_chat_turns?: number; + /** @description The total number of users who interacted with Copilot Chat in the IDE during the day specified. */ + readonly total_active_chat_users?: number; + /** @description Breakdown of Copilot code completions usage by language and editor */ + readonly breakdown: readonly ({ + /** @description The language in which Copilot suggestions were shown to users in the specified editor. */ + readonly language?: string; + /** @description The editor in which Copilot suggestions were shown to users for the specified language. */ + readonly editor?: string; + /** @description The number of Copilot suggestions shown to users in the editor specified during the day specified. */ + readonly suggestions_count?: number; + /** @description The number of Copilot suggestions accepted by users in the editor specified during the day specified. */ + readonly acceptances_count?: number; + /** @description The number of lines of code suggested by Copilot in the editor specified during the day specified. */ + readonly lines_suggested?: number; + /** @description The number of lines of code accepted by users in the editor specified during the day specified. */ + readonly lines_accepted?: number; + /** @description The number of users who were shown Copilot completion suggestions in the editor specified during the day specified. */ + readonly active_users?: number; + } & { + readonly [key: string]: unknown; + })[] | null; + }; /** * Dependabot Secret for an Organization * @description Secrets for GitHub Dependabot for an organization. @@ -23608,6 +23983,16 @@ export interface components { readonly name: string; /** @description A short description about who this role is for or what permissions it grants. */ readonly description?: string | null; + /** + * @description The system role from which this role inherits permissions. + * @enum {string|null} + */ + readonly base_role?: "read" | "triage" | "write" | "maintain" | "admin" | null; + /** + * @description Source answers the question, "where did this role come from?" + * @enum {string|null} + */ + readonly source?: "Organization" | "Enterprise" | "Predefined" | null; /** @description A list of permissions included in this role. */ readonly permissions: readonly string[]; readonly organization: components["schemas"]["nullable-simple-user"]; @@ -23627,6 +24012,12 @@ export interface components { * @description The Relationship a Team has with a role. */ readonly "team-role-assignment": { + /** + * @description Determines if the team has a direct, indirect, or mixed relationship to a role + * @example direct + * @enum {string} + */ + readonly assignment?: "direct" | "indirect" | "mixed"; readonly id: number; readonly node_id: string; readonly name: string; @@ -23722,6 +24113,14 @@ export interface components { * @description The Relationship a User has with a role. */ readonly "user-role-assignment": { + /** + * @description Determines if the user has a direct, indirect, or mixed relationship to a role + * @example direct + * @enum {string} + */ + readonly assignment?: "direct" | "indirect" | "mixed"; + /** @description Team the user has gotten the role through */ + readonly inherited_from?: readonly components["schemas"]["team-simple"][]; readonly name?: string | null; readonly email?: string | null; /** @example octocat */ @@ -23926,6 +24325,68 @@ export interface components { /** @description Date and time when the associated fine-grained personal access token was last used for authentication. */ readonly token_last_used_at: string | null; }; + /** + * Organization private registry + * @description Private registry configuration for an organization + */ + readonly "org-private-registry-configuration": { + /** + * @description The name of the private registry configuration. + * @example MAVEN_REPOSITORY_SECRET + */ + readonly name: string; + /** + * @description The registry type. + * @enum {string} + */ + readonly registry_type: "maven_repository"; + /** + * @description The username to use when authenticating with the private registry. + * @example monalisa + */ + readonly username?: string | null; + /** + * @description Which type of organization repositories have access to the private registry. + * @enum {string} + */ + readonly visibility: "all" | "private" | "selected"; + /** Format: date-time */ + readonly created_at: string; + /** Format: date-time */ + readonly updated_at: string; + }; + /** + * Organization private registry + * @description Private registry configuration for an organization + */ + readonly "org-private-registry-configuration-with-selected-repositories": { + /** + * @description The name of the private registry configuration. + * @example MAVEN_REPOSITORY_SECRET + */ + readonly name: string; + /** + * @description The registry type. + * @enum {string} + */ + readonly registry_type: "maven_repository"; + /** + * @description The username to use when authenticating with the private registry. + * @example monalisa + */ + readonly username?: string; + /** + * @description Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry. + * @enum {string} + */ + readonly visibility: "all" | "private" | "selected"; + /** @description An array of repository IDs that can access the organization private registry when `visibility` is set to `selected`. */ + readonly selected_repository_ids?: readonly number[]; + /** Format: date-time */ + readonly created_at: string; + /** Format: date-time */ + readonly updated_at: string; + }; /** * Project * @description Projects are a way to organize columns and cards of work. @@ -24003,6 +24464,12 @@ export interface components { * @description The URL that can be used to fetch, update, or delete info about this property via the API. */ readonly url?: string; + /** + * @description The source type of the property + * @example organization + * @enum {string} + */ + readonly source_type?: "organization" | "enterprise"; /** * @description The type of the value for the property * @example single_select @@ -24025,6 +24492,27 @@ export interface components { */ readonly values_editable_by?: "org_actors" | "org_and_repo_actors" | null; }; + /** + * Custom Property Set Payload + * @description Custom property set payload + */ + readonly "custom-property-set-payload": { + /** + * @description The type of the value for the property + * @example single_select + * @enum {string} + */ + readonly value_type: "string" | "single_select" | "multi_select" | "true_false"; + /** @description Whether the property is required. */ + readonly required?: boolean; + /** @description Default value of the property */ + readonly default_value?: (string | readonly string[]) | null; + /** @description Short description of the property */ + readonly description?: string | null; + /** @description An ordered list of the allowed values of the property. + * The property can have up to 200 allowed values. */ + readonly allowed_values?: readonly string[] | null; + }; /** * Custom Property Value * @description Custom property name and associated value @@ -24829,6 +25317,7 @@ export interface components { * @description Conditions for an organization ruleset. * The branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties. * The push rulesets conditions object does not require the `ref_name` property. + * For repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`. */ readonly "org-ruleset-conditions": (components["schemas"]["repository-ruleset-conditions"] & components["schemas"]["repository-ruleset-conditions-repository-name-target"]) | (components["schemas"]["repository-ruleset-conditions"] & components["schemas"]["repository-ruleset-conditions-repository-id-target"]) | (components["schemas"]["repository-ruleset-conditions"] & components["schemas"]["repository-ruleset-conditions-repository-property-target"]); /** @@ -24937,6 +25426,8 @@ export interface components { /** @enum {string} */ readonly type: "pull_request"; readonly parameters?: { + /** @description When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled. */ + readonly allowed_merge_methods?: readonly string[]; /** @description New, reviewable commits pushed will dismiss previous pull request review approvals. */ readonly dismiss_stale_reviews_on_push: boolean; /** @description Require an approving review in pull requests that modify files that have a designated code owner. */ @@ -25202,12 +25693,12 @@ export interface components { * @description The target of the ruleset * @enum {string} */ - readonly target?: "branch" | "tag" | "push"; + readonly target?: "branch" | "tag" | "push" | "repository"; /** * @description The type of the source of the ruleset * @enum {string} */ - readonly source_type?: "Repository" | "Organization"; + readonly source_type?: "Repository" | "Organization" | "Enterprise"; /** @description The name of the source */ readonly source: string; readonly enforcement: components["schemas"]["repository-rule-enforcement"]; @@ -26361,6 +26852,7 @@ export interface components { readonly actions_runner_registration?: components["schemas"]["rate-limit"]; readonly scim?: components["schemas"]["rate-limit"]; readonly dependency_snapshots?: components["schemas"]["rate-limit"]; + readonly code_scanning_autofix?: components["schemas"]["rate-limit"]; }; readonly rate: components["schemas"]["rate-limit"]; }; @@ -27498,6 +27990,7 @@ export interface components { readonly reason: string; readonly payload: string | null; readonly signature: string | null; + readonly verified_at?: string | null; }; /** * Diff Entry @@ -28069,6 +28562,36 @@ export interface components { * @enum {string} */ readonly "code-scanning-alert-set-state": "open" | "dismissed"; + /** + * @description The status of an autofix. + * @enum {string} + */ + readonly "code-scanning-autofix-status": "pending" | "error" | "success" | "outdated"; + /** @description The description of an autofix. */ + readonly "code-scanning-autofix-description": string | null; + /** + * Format: date-time + * @description The start time of an autofix in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + readonly "code-scanning-autofix-started-at": string; + readonly "code-scanning-autofix": { + readonly status: components["schemas"]["code-scanning-autofix-status"]; + readonly description: components["schemas"]["code-scanning-autofix-description"]; + readonly started_at: components["schemas"]["code-scanning-autofix-started-at"]; + }; + /** @description Commit an autofix for a code scanning alert */ + readonly "code-scanning-autofix-commits": { + /** @description The Git reference of target branch for the commit. Branch needs to already exist. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ + readonly target_ref?: string; + /** @description Commit message to be used. */ + readonly message?: string; + } | null; + readonly "code-scanning-autofix-commits-response": { + /** @description The Git reference of target branch for the commit. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ + readonly target_ref?: string; + /** @description SHA of commit with autofix. */ + readonly sha?: string; + }; /** * @description An identifier for the upload. * @example 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53 @@ -28298,7 +28821,7 @@ export interface components { */ readonly state?: "configured" | "not-configured"; /** @description Languages to be analyzed. */ - readonly languages?: readonly ("c-cpp" | "csharp" | "go" | "java-kotlin" | "javascript-typescript" | "javascript" | "python" | "ruby" | "typescript" | "swift")[]; + readonly languages?: readonly ("actions" | "c-cpp" | "csharp" | "go" | "java-kotlin" | "javascript-typescript" | "javascript" | "python" | "ruby" | "typescript" | "swift")[]; /** * @description CodeQL query suite to be used. * @enum {string} @@ -28323,13 +28846,23 @@ export interface components { * @enum {string} */ readonly state?: "configured" | "not-configured"; + /** + * @description Runner type to be used. + * @enum {string} + */ + readonly runner_type?: "standard" | "labeled"; + /** + * @description Runner label to be used if the runner type is labeled. + * @example code-scanning + */ + readonly runner_label?: string | null; /** * @description CodeQL query suite to be used. * @enum {string} */ readonly query_suite?: "default" | "extended"; /** @description CodeQL languages to be analyzed. */ - readonly languages?: readonly ("c-cpp" | "csharp" | "go" | "java-kotlin" | "javascript-typescript" | "python" | "ruby" | "swift")[]; + readonly languages?: readonly ("actions" | "c-cpp" | "csharp" | "go" | "java-kotlin" | "javascript-typescript" | "python" | "ruby" | "swift")[]; }; /** @description You can use `run_url` to track the status of the run. This includes a property status and conclusion. * You should not rely on this always being an actions workflow run object. */ @@ -29285,6 +29818,7 @@ export interface components { readonly reason?: string; readonly signature?: string | null; readonly payload?: string | null; + readonly verified_at?: string | null; }; }; }; @@ -30039,6 +30573,7 @@ export interface components { readonly reason: string; readonly signature: string | null; readonly payload: string | null; + readonly verified_at?: string | null; }; /** Format: uri */ readonly html_url: string; @@ -30400,6 +30935,7 @@ export interface components { readonly performed_via_github_app?: components["schemas"]["nullable-integration"]; readonly author_association: components["schemas"]["author-association"]; readonly reactions?: components["schemas"]["reaction-rollup"]; + readonly sub_issues_summary?: components["schemas"]["sub-issues-summary"]; } | null; /** * Issue Event Label @@ -30978,6 +31514,7 @@ export interface components { readonly reason: string; readonly signature: string | null; readonly payload: string | null; + readonly verified_at?: string | null; }; /** Format: uri */ readonly html_url: string; @@ -32114,6 +32651,16 @@ export interface components { * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ readonly push_protection_bypassed_at?: string | null; + readonly push_protection_bypass_request_reviewer?: components["schemas"]["nullable-simple-user"]; + /** @description An optional comment when reviewing a push protection bypass. */ + readonly push_protection_bypass_request_reviewer_comment?: string | null; + /** @description An optional comment when requesting a push protection bypass. */ + readonly push_protection_bypass_request_comment?: string | null; + /** + * Format: uri + * @description The URL to a push protection bypass request. + */ + readonly push_protection_bypass_request_html_url?: string | null; /** * @description The token status as of the latest validity check. * @enum {string} @@ -32251,7 +32798,7 @@ export interface components { /** * Format: uri * @description The API URL to get the pull request where the secret was detected. - * @example https://api.github.com/repos/octocat/Hello-World/pull/2846 + * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846 */ readonly pull_request_title_url: string; }; @@ -32260,7 +32807,7 @@ export interface components { /** * Format: uri * @description The API URL to get the pull request where the secret was detected. - * @example https://api.github.com/repos/octocat/Hello-World/pull/2846 + * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846 */ readonly pull_request_body_url: string; }; @@ -32315,6 +32862,34 @@ export interface components { /** @description The token type this bypass is for. */ readonly token_type?: string; }; + /** @description Information on a single scan performed by secret scanning on the repository */ + readonly "secret-scanning-scan": { + /** @description The type of scan */ + readonly type?: string; + /** @description The state of the scan. Either "completed", "running", or "pending" */ + readonly status?: string; + /** + * Format: date-time + * @description The time that the scan was completed. Empty if the scan is running + */ + readonly completed_at?: string | null; + /** + * Format: date-time + * @description The time that the scan was started. Empty if the scan is pending + */ + readonly started_at?: string | null; + }; + readonly "secret-scanning-scan-history": { + readonly incremental_scans?: readonly components["schemas"]["secret-scanning-scan"][]; + readonly pattern_update_scans?: readonly components["schemas"]["secret-scanning-scan"][]; + readonly backfill_scans?: readonly components["schemas"]["secret-scanning-scan"][]; + readonly custom_pattern_backfill_scans?: readonly (components["schemas"]["secret-scanning-scan"] & { + /** @description Name of the custom pattern for custom pattern scans */ + readonly pattern_name?: string; + /** @description Level at which the custom pattern is defined, one of "repository", "organization", or "enterprise" */ + readonly pattern_scope?: string; + })[]; + }; readonly "repository-advisory-create": { /** @description A short summary of the advisory. */ readonly summary: string; @@ -32749,6 +33324,12 @@ export interface components { readonly default?: boolean; readonly description?: string | null; }[]; + /** Sub-issues Summary */ + readonly sub_issues_summary?: { + readonly total: number; + readonly completed: number; + readonly percent_completed: number; + }; readonly state: string; readonly state_reason?: string | null; readonly assignee: components["schemas"]["nullable-simple-user"]; @@ -35340,6 +35921,12 @@ export interface components { }; /** Format: uri */ readonly repository_url: string; + /** Sub-issues Summary */ + readonly sub_issues_summary?: { + readonly total: number; + readonly completed: number; + readonly percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -35828,6 +36415,12 @@ export interface components { }; /** Format: uri */ readonly repository_url: string; + /** Sub-issues Summary */ + readonly sub_issues_summary?: { + readonly total: number; + readonly completed: number; + readonly percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -38908,6 +39501,16 @@ export interface components { * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ readonly push_protection_bypassed_at?: string | null; + readonly push_protection_bypass_request_reviewer?: components["schemas"]["nullable-simple-user"]; + /** @description An optional comment when reviewing a push protection bypass. */ + readonly push_protection_bypass_request_reviewer_comment?: string | null; + /** @description An optional comment when requesting a push protection bypass. */ + readonly push_protection_bypass_request_comment?: string | null; + /** + * Format: uri + * @description The URL to a push protection bypass request. + */ + readonly push_protection_bypass_request_html_url?: string | null; /** @description Whether the detected secret was publicly leaked. */ readonly publicly_leaked?: boolean | null; /** @description Whether the detected secret was found in multiple repositories in the same organization or business. */ @@ -43992,21 +44595,424 @@ export interface components { * @enum {string} */ readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue comment */ - readonly body: string; + /** @description Contents of the issue comment */ + readonly body: string; + /** Format: date-time */ + readonly created_at: string; + /** Format: uri */ + readonly html_url: string; + /** + * Format: int64 + * @description Unique identifier of the issue comment + */ + readonly id: number; + /** Format: uri */ + readonly issue_url: string; + readonly node_id: string; + readonly performed_via_github_app: components["schemas"]["nullable-integration"]; + /** Reactions */ + readonly reactions: { + readonly "+1": number; + readonly "-1": number; + readonly confused: number; + readonly eyes: number; + readonly heart: number; + readonly hooray: number; + readonly laugh: number; + readonly rocket: number; + readonly total_count: number; + /** Format: uri */ + readonly url: string; + }; + /** Format: date-time */ + readonly updated_at: string; + /** + * Format: uri + * @description URL for the issue comment + */ + readonly url: string; + /** User */ + readonly user: { + /** Format: uri */ + readonly avatar_url?: string; + readonly deleted?: boolean; + readonly email?: string | null; + /** Format: uri-template */ + readonly events_url?: string; + /** Format: uri */ + readonly followers_url?: string; + /** Format: uri-template */ + readonly following_url?: string; + /** Format: uri-template */ + readonly gists_url?: string; + readonly gravatar_id?: string; + /** Format: uri */ + readonly html_url?: string; + /** Format: int64 */ + readonly id: number; + readonly login: string; + readonly name?: string; + readonly node_id?: string; + /** Format: uri */ + readonly organizations_url?: string; + /** Format: uri */ + readonly received_events_url?: string; + /** Format: uri */ + readonly repos_url?: string; + readonly site_admin?: boolean; + /** Format: uri-template */ + readonly starred_url?: string; + /** Format: uri */ + readonly subscriptions_url?: string; + /** @enum {string} */ + readonly type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + readonly url?: string; + readonly user_view_type?: string; + } | null; + }; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. */ + readonly issue: { + /** @enum {string|null} */ + readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + /** User */ + readonly assignee?: { + /** Format: uri */ + readonly avatar_url?: string; + readonly deleted?: boolean; + readonly email?: string | null; + /** Format: uri-template */ + readonly events_url?: string; + /** Format: uri */ + readonly followers_url?: string; + /** Format: uri-template */ + readonly following_url?: string; + /** Format: uri-template */ + readonly gists_url?: string; + readonly gravatar_id?: string; + /** Format: uri */ + readonly html_url?: string; + readonly id: number; + readonly login: string; + readonly name?: string; + readonly node_id?: string; + /** Format: uri */ + readonly organizations_url?: string; + /** Format: uri */ + readonly received_events_url?: string; + /** Format: uri */ + readonly repos_url?: string; + readonly site_admin?: boolean; + /** Format: uri-template */ + readonly starred_url?: string; + /** Format: uri */ + readonly subscriptions_url?: string; + /** @enum {string} */ + readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + /** Format: uri */ + readonly url?: string; + readonly user_view_type?: string; + } | null; + readonly assignees: readonly ({ + /** Format: uri */ + readonly avatar_url?: string; + readonly deleted?: boolean; + readonly email?: string | null; + /** Format: uri-template */ + readonly events_url?: string; + /** Format: uri */ + readonly followers_url?: string; + /** Format: uri-template */ + readonly following_url?: string; + /** Format: uri-template */ + readonly gists_url?: string; + readonly gravatar_id?: string; + /** Format: uri */ + readonly html_url?: string; + readonly id: number; + readonly login: string; + readonly name?: string; + readonly node_id?: string; + /** Format: uri */ + readonly organizations_url?: string; + /** Format: uri */ + readonly received_events_url?: string; + /** Format: uri */ + readonly repos_url?: string; + readonly site_admin?: boolean; + /** Format: uri-template */ + readonly starred_url?: string; + /** Format: uri */ + readonly subscriptions_url?: string; + /** @enum {string} */ + readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + /** Format: uri */ + readonly url?: string; + readonly user_view_type?: string; + } | null)[]; + /** + * AuthorAssociation + * @description How the author is associated with the repository. + * @enum {string} + */ + readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + /** @description Contents of the issue */ + readonly body: string | null; + /** Format: date-time */ + readonly closed_at: string | null; + readonly comments: number; + /** Format: uri */ + readonly comments_url: string; /** Format: date-time */ readonly created_at: string; + readonly draft?: boolean; + /** Format: uri */ + readonly events_url: string; /** Format: uri */ readonly html_url: string; + /** Format: int64 */ + readonly id: number; + readonly labels?: readonly { + /** @description 6-character hex code, without the leading #, identifying the color */ + readonly color: string; + readonly default: boolean; + readonly description: string | null; + readonly id: number; + /** @description The name of the label. */ + readonly name: string; + readonly node_id: string; + /** + * Format: uri + * @description URL for the label + */ + readonly url: string; + }[]; + /** Format: uri-template */ + readonly labels_url: string; + readonly locked?: boolean; /** - * Format: int64 - * @description Unique identifier of the issue comment + * Milestone + * @description A collection of related issues and pull requests. */ - readonly id: number; - /** Format: uri */ - readonly issue_url: string; + readonly milestone: { + /** Format: date-time */ + readonly closed_at: string | null; + readonly closed_issues: number; + /** Format: date-time */ + readonly created_at: string; + /** User */ + readonly creator: { + /** Format: uri */ + readonly avatar_url?: string; + readonly deleted?: boolean; + readonly email?: string | null; + /** Format: uri-template */ + readonly events_url?: string; + /** Format: uri */ + readonly followers_url?: string; + /** Format: uri-template */ + readonly following_url?: string; + /** Format: uri-template */ + readonly gists_url?: string; + readonly gravatar_id?: string; + /** Format: uri */ + readonly html_url?: string; + readonly id: number; + readonly login: string; + readonly name?: string; + readonly node_id?: string; + /** Format: uri */ + readonly organizations_url?: string; + /** Format: uri */ + readonly received_events_url?: string; + /** Format: uri */ + readonly repos_url?: string; + readonly site_admin?: boolean; + /** Format: uri-template */ + readonly starred_url?: string; + /** Format: uri */ + readonly subscriptions_url?: string; + /** @enum {string} */ + readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + /** Format: uri */ + readonly url?: string; + readonly user_view_type?: string; + } | null; + readonly description: string | null; + /** Format: date-time */ + readonly due_on: string | null; + /** Format: uri */ + readonly html_url: string; + readonly id: number; + /** Format: uri */ + readonly labels_url: string; + readonly node_id: string; + /** @description The number of the milestone. */ + readonly number: number; + readonly open_issues: number; + /** + * @description The state of the milestone. + * @enum {string} + */ + readonly state: "open" | "closed"; + /** @description The title of the milestone. */ + readonly title: string; + /** Format: date-time */ + readonly updated_at: string; + /** Format: uri */ + readonly url: string; + } | null; readonly node_id: string; - readonly performed_via_github_app: components["schemas"]["nullable-integration"]; + readonly number: number; + /** + * App + * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. + */ + readonly performed_via_github_app?: { + /** Format: date-time */ + readonly created_at: string | null; + readonly description: string | null; + /** @description The list of events for the GitHub app */ + readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "pull_request_review_thread")[]; + /** Format: uri */ + readonly external_url: string | null; + /** Format: uri */ + readonly html_url: string; + /** @description Unique identifier of the GitHub app */ + readonly id: number | null; + /** @description The name of the GitHub app */ + readonly name: string; + readonly node_id: string; + /** User */ + readonly owner: { + /** Format: uri */ + readonly avatar_url?: string; + readonly deleted?: boolean; + readonly email?: string | null; + /** Format: uri-template */ + readonly events_url?: string; + /** Format: uri */ + readonly followers_url?: string; + /** Format: uri-template */ + readonly following_url?: string; + /** Format: uri-template */ + readonly gists_url?: string; + readonly gravatar_id?: string; + /** Format: uri */ + readonly html_url?: string; + readonly id: number; + readonly login: string; + readonly name?: string; + readonly node_id?: string; + /** Format: uri */ + readonly organizations_url?: string; + /** Format: uri */ + readonly received_events_url?: string; + /** Format: uri */ + readonly repos_url?: string; + readonly site_admin?: boolean; + /** Format: uri-template */ + readonly starred_url?: string; + /** Format: uri */ + readonly subscriptions_url?: string; + /** @enum {string} */ + readonly type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + readonly url?: string; + readonly user_view_type?: string; + } | null; + /** @description The set of permissions for the GitHub app */ + readonly permissions?: { + /** @enum {string} */ + readonly actions?: "read" | "write"; + /** @enum {string} */ + readonly administration?: "read" | "write"; + /** @enum {string} */ + readonly checks?: "read" | "write"; + /** @enum {string} */ + readonly content_references?: "read" | "write"; + /** @enum {string} */ + readonly contents?: "read" | "write"; + /** @enum {string} */ + readonly deployments?: "read" | "write"; + /** @enum {string} */ + readonly discussions?: "read" | "write"; + /** @enum {string} */ + readonly emails?: "read" | "write"; + /** @enum {string} */ + readonly environments?: "read" | "write"; + /** @enum {string} */ + readonly issues?: "read" | "write"; + /** @enum {string} */ + readonly keys?: "read" | "write"; + /** @enum {string} */ + readonly members?: "read" | "write"; + /** @enum {string} */ + readonly metadata?: "read" | "write"; + /** @enum {string} */ + readonly organization_administration?: "read" | "write"; + /** @enum {string} */ + readonly organization_hooks?: "read" | "write"; + /** @enum {string} */ + readonly organization_packages?: "read" | "write"; + /** @enum {string} */ + readonly organization_plan?: "read" | "write"; + /** @enum {string} */ + readonly organization_projects?: "read" | "write" | "admin"; + /** @enum {string} */ + readonly organization_secrets?: "read" | "write"; + /** @enum {string} */ + readonly organization_self_hosted_runners?: "read" | "write"; + /** @enum {string} */ + readonly organization_user_blocking?: "read" | "write"; + /** @enum {string} */ + readonly packages?: "read" | "write"; + /** @enum {string} */ + readonly pages?: "read" | "write"; + /** @enum {string} */ + readonly pull_requests?: "read" | "write"; + /** @enum {string} */ + readonly repository_hooks?: "read" | "write"; + /** @enum {string} */ + readonly repository_projects?: "read" | "write" | "admin"; + /** @enum {string} */ + readonly secret_scanning_alerts?: "read" | "write"; + /** @enum {string} */ + readonly secrets?: "read" | "write"; + /** @enum {string} */ + readonly security_events?: "read" | "write"; + /** @enum {string} */ + readonly security_scanning_alert?: "read" | "write"; + /** @enum {string} */ + readonly single_file?: "read" | "write"; + /** @enum {string} */ + readonly statuses?: "read" | "write"; + /** @enum {string} */ + readonly team_discussions?: "read" | "write"; + /** @enum {string} */ + readonly vulnerability_alerts?: "read" | "write"; + /** @enum {string} */ + readonly workflows?: "read" | "write"; + }; + /** @description The slug name of the GitHub app */ + readonly slug?: string; + /** Format: date-time */ + readonly updated_at: string | null; + } | null; + readonly pull_request?: { + /** Format: uri */ + readonly diff_url?: string; + /** Format: uri */ + readonly html_url?: string; + /** Format: date-time */ + readonly merged_at?: string | null; + /** Format: uri */ + readonly patch_url?: string; + /** Format: uri */ + readonly url?: string; + }; /** Reactions */ readonly reactions: { readonly "+1": number; @@ -44021,11 +45027,29 @@ export interface components { /** Format: uri */ readonly url: string; }; + /** Format: uri */ + readonly repository_url: string; + /** Sub-issues Summary */ + readonly sub_issues_summary?: { + readonly total: number; + readonly completed: number; + readonly percent_completed: number; + }; + /** + * @description State of the issue; either 'open' or 'closed' + * @enum {string} + */ + readonly state?: "open" | "closed"; + readonly state_reason?: string | null; + /** Format: uri */ + readonly timeline_url?: string; + /** @description Title of the issue */ + readonly title: string; /** Format: date-time */ readonly updated_at: string; /** * Format: uri - * @description URL for the issue comment + * @description URL for the issue */ readonly url: string; /** User */ @@ -44062,12 +45086,135 @@ export interface components { /** Format: uri */ readonly subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + /** Format: uri */ + readonly url?: string; + readonly user_view_type?: string; + } | null; + } & { + readonly active_lock_reason?: string | null; + /** User */ + readonly assignee: { + /** Format: uri */ + readonly avatar_url?: string; + readonly deleted?: boolean; + readonly email?: string | null; + /** Format: uri-template */ + readonly events_url?: string; + /** Format: uri */ + readonly followers_url?: string; + /** Format: uri-template */ + readonly following_url?: string; + /** Format: uri-template */ + readonly gists_url?: string; + readonly gravatar_id?: string; + /** Format: uri */ + readonly html_url?: string; + readonly id: number; + readonly login: string; + readonly name?: string; + readonly node_id?: string; + /** Format: uri */ + readonly organizations_url?: string; + /** Format: uri */ + readonly received_events_url?: string; + /** Format: uri */ + readonly repos_url?: string; + readonly site_admin?: boolean; + /** Format: uri-template */ + readonly starred_url?: string; + /** Format: uri */ + readonly subscriptions_url?: string; + /** @enum {string} */ + readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; readonly user_view_type?: string; } | null; + readonly assignees?: readonly Record[]; + readonly author_association?: string; + readonly body?: string | null; + readonly closed_at?: string | null; + readonly comments?: number; + readonly comments_url?: string; + readonly created_at?: string; + readonly events_url?: string; + readonly html_url?: string; + readonly id?: number; + readonly labels: readonly { + /** @description 6-character hex code, without the leading #, identifying the color */ + readonly color: string; + readonly default: boolean; + readonly description: string | null; + readonly id: number; + /** @description The name of the label. */ + readonly name: string; + readonly node_id: string; + /** + * Format: uri + * @description URL for the label + */ + readonly url: string; + }[]; + readonly labels_url?: string; + readonly locked: boolean; + readonly milestone?: Record; + readonly node_id?: string; + readonly number?: number; + readonly performed_via_github_app?: Record; + readonly reactions?: { + readonly "+1"?: number; + readonly "-1"?: number; + readonly confused?: number; + readonly eyes?: number; + readonly heart?: number; + readonly hooray?: number; + readonly laugh?: number; + readonly rocket?: number; + readonly total_count?: number; + readonly url?: string; + }; + readonly repository_url?: string; + /** + * @description State of the issue; either 'open' or 'closed' + * @enum {string} + */ + readonly state: "open" | "closed"; + readonly timeline_url?: string; + readonly title?: string; + readonly updated_at?: string; + readonly url?: string; + readonly user?: { + readonly avatar_url?: string; + readonly events_url?: string; + readonly followers_url?: string; + readonly following_url?: string; + readonly gists_url?: string; + readonly gravatar_id?: string; + readonly html_url?: string; + /** Format: int64 */ + readonly id?: number; + readonly login?: string; + readonly node_id?: string; + readonly organizations_url?: string; + readonly received_events_url?: string; + readonly repos_url?: string; + readonly site_admin?: boolean; + readonly starred_url?: string; + readonly subscriptions_url?: string; + readonly type?: string; + readonly url?: string; + }; }; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; + }; + /** issue_comment deleted event */ + readonly "webhook-issue-comment-deleted": { + /** @enum {string} */ + readonly action: "deleted"; + readonly comment: components["schemas"]["webhooks_issue_comment"]; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. */ @@ -44272,7 +45419,7 @@ export interface components { readonly created_at: string | null; readonly description: string | null; /** @description The list of events for the GitHub app */ - readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "pull_request_review_thread")[]; + readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; /** Format: uri */ readonly external_url: string | null; /** Format: uri */ @@ -44357,7 +45504,7 @@ export interface components { /** @enum {string} */ readonly organization_plan?: "read" | "write"; /** @enum {string} */ - readonly organization_projects?: "read" | "write" | "admin"; + readonly organization_projects?: "read" | "write"; /** @enum {string} */ readonly organization_secrets?: "read" | "write"; /** @enum {string} */ @@ -44373,7 +45520,7 @@ export interface components { /** @enum {string} */ readonly repository_hooks?: "read" | "write"; /** @enum {string} */ - readonly repository_projects?: "read" | "write" | "admin"; + readonly repository_projects?: "read" | "write"; /** @enum {string} */ readonly secret_scanning_alerts?: "read" | "write"; /** @enum {string} */ @@ -44426,6 +45573,12 @@ export interface components { }; /** Format: uri */ readonly repository_url: string; + /** Sub-issues Summary */ + readonly sub_issues_summary?: { + readonly total: number; + readonly completed: number; + readonly percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -44595,16 +45748,18 @@ export interface components { readonly subscriptions_url?: string; readonly type?: string; readonly url?: string; + readonly user_view_type?: string; }; }; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user"]; }; - /** issue_comment deleted event */ - readonly "webhook-issue-comment-deleted": { + /** issue_comment edited event */ + readonly "webhook-issue-comment-edited": { /** @enum {string} */ - readonly action: "deleted"; + readonly action: "edited"; + readonly changes: components["schemas"]["webhooks_changes"]; readonly comment: components["schemas"]["webhooks_issue_comment"]; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; @@ -44810,7 +45965,7 @@ export interface components { readonly created_at: string | null; readonly description: string | null; /** @description The list of events for the GitHub app */ - readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; + readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "pull_request_review_thread")[]; /** Format: uri */ readonly external_url: string | null; /** Format: uri */ @@ -44895,7 +46050,7 @@ export interface components { /** @enum {string} */ readonly organization_plan?: "read" | "write"; /** @enum {string} */ - readonly organization_projects?: "read" | "write"; + readonly organization_projects?: "read" | "write" | "admin"; /** @enum {string} */ readonly organization_secrets?: "read" | "write"; /** @enum {string} */ @@ -44964,6 +46119,12 @@ export interface components { }; /** Format: uri */ readonly repository_url: string; + /** Sub-issues Summary */ + readonly sub_issues_summary?: { + readonly total: number; + readonly completed: number; + readonly percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -45133,22 +46294,37 @@ export interface components { readonly subscriptions_url?: string; readonly type?: string; readonly url?: string; - readonly user_view_type?: string; }; }; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user"]; }; - /** issue_comment edited event */ - readonly "webhook-issue-comment-edited": { - /** @enum {string} */ - readonly action: "edited"; - readonly changes: components["schemas"]["webhooks_changes"]; - readonly comment: components["schemas"]["webhooks_issue_comment"]; + /** issues assigned event */ + readonly "webhook-issues-assigned": { + /** + * @description The action that was performed. + * @enum {string} + */ + readonly action: "assigned"; + readonly assignee?: components["schemas"]["webhooks_user"]; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; - /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. */ + readonly issue: components["schemas"]["webhooks_issue"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user"]; + }; + /** issues closed event */ + readonly "webhook-issues-closed": { + /** + * @description The action that was performed. + * @enum {string} + */ + readonly action: "closed"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ readonly issue: { /** @enum {string|null} */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; @@ -45350,7 +46526,7 @@ export interface components { readonly created_at: string | null; readonly description: string | null; /** @description The list of events for the GitHub app */ - readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "pull_request_review_thread")[]; + readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "security_and_analysis" | "reminder" | "pull_request_review_thread")[]; /** Format: uri */ readonly external_url: string | null; /** Format: uri */ @@ -45504,6 +46680,12 @@ export interface components { }; /** Format: uri */ readonly repository_url: string; + /** Sub-issues Summary */ + readonly sub_issues_summary?: { + readonly total: number; + readonly completed: number; + readonly percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -45562,71 +46744,20 @@ export interface components { } | null; } & { readonly active_lock_reason?: string | null; - /** User */ - readonly assignee: { - /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; - /** Format: uri-template */ - readonly events_url?: string; - /** Format: uri */ - readonly followers_url?: string; - /** Format: uri-template */ - readonly following_url?: string; - /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; - /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; - /** Format: uri */ - readonly organizations_url?: string; - /** Format: uri */ - readonly received_events_url?: string; - /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; - /** Format: uri-template */ - readonly starred_url?: string; - /** Format: uri */ - readonly subscriptions_url?: string; - /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; - } | null; + readonly assignee?: Record; readonly assignees?: readonly Record[]; readonly author_association?: string; readonly body?: string | null; - readonly closed_at?: string | null; + readonly closed_at: string | null; readonly comments?: number; readonly comments_url?: string; readonly created_at?: string; readonly events_url?: string; readonly html_url?: string; readonly id?: number; - readonly labels: readonly { - /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; - /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; - /** - * Format: uri - * @description URL for the label - */ - readonly url: string; - }[]; + readonly labels?: readonly Record[]; readonly labels_url?: string; - readonly locked: boolean; + readonly locked?: boolean; readonly milestone?: Record; readonly node_id?: string; readonly number?: number; @@ -45644,11 +46775,8 @@ export interface components { readonly url?: string; }; readonly repository_url?: string; - /** - * @description State of the issue; either 'open' or 'closed' - * @enum {string} - */ - readonly state: "open" | "closed"; + /** @enum {string} */ + readonly state: "closed" | "open"; readonly timeline_url?: string; readonly title?: string; readonly updated_at?: string; @@ -45673,37 +46801,23 @@ export interface components { readonly subscriptions_url?: string; readonly type?: string; readonly url?: string; + readonly user_view_type?: string; }; }; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user"]; }; - /** issues assigned event */ - readonly "webhook-issues-assigned": { - /** - * @description The action that was performed. - * @enum {string} - */ - readonly action: "assigned"; - readonly assignee?: components["schemas"]["webhooks_user"]; + /** issues deleted event */ + readonly "webhook-issues-deleted": { + /** @enum {string} */ + readonly action: "deleted"; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; - readonly issue: components["schemas"]["webhooks_issue"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user"]; - }; - /** issues closed event */ - readonly "webhook-issues-closed": { /** - * @description The action that was performed. - * @enum {string} + * Issue + * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ - readonly action: "closed"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ readonly issue: { /** @enum {string|null} */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; @@ -45740,7 +46854,7 @@ export interface components { /** Format: uri */ readonly subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; readonly user_view_type?: string; @@ -45777,10 +46891,9 @@ export interface components { /** Format: uri */ readonly subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; - readonly user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -45865,7 +46978,7 @@ export interface components { /** Format: uri */ readonly subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; readonly user_view_type?: string; @@ -45905,7 +47018,7 @@ export interface components { readonly created_at: string | null; readonly description: string | null; /** @description The list of events for the GitHub app */ - readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "security_and_analysis" | "reminder" | "pull_request_review_thread")[]; + readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder")[]; /** Format: uri */ readonly external_url: string | null; /** Format: uri */ @@ -45990,7 +47103,7 @@ export interface components { /** @enum {string} */ readonly organization_plan?: "read" | "write"; /** @enum {string} */ - readonly organization_projects?: "read" | "write" | "admin"; + readonly organization_projects?: "read" | "write"; /** @enum {string} */ readonly organization_secrets?: "read" | "write"; /** @enum {string} */ @@ -46059,6 +47172,12 @@ export interface components { }; /** Format: uri */ readonly repository_url: string; + /** Sub-issues Summary */ + readonly sub_issues_summary?: { + readonly total: number; + readonly completed: number; + readonly percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -46110,81 +47229,20 @@ export interface components { /** Format: uri */ readonly subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; readonly user_view_type?: string; } | null; - } & { - readonly active_lock_reason?: string | null; - readonly assignee?: Record; - readonly assignees?: readonly Record[]; - readonly author_association?: string; - readonly body?: string | null; - readonly closed_at: string | null; - readonly comments?: number; - readonly comments_url?: string; - readonly created_at?: string; - readonly events_url?: string; - readonly html_url?: string; - readonly id?: number; - readonly labels?: readonly Record[]; - readonly labels_url?: string; - readonly locked?: boolean; - readonly milestone?: Record; - readonly node_id?: string; - readonly number?: number; - readonly performed_via_github_app?: Record; - readonly reactions?: { - readonly "+1"?: number; - readonly "-1"?: number; - readonly confused?: number; - readonly eyes?: number; - readonly heart?: number; - readonly hooray?: number; - readonly laugh?: number; - readonly rocket?: number; - readonly total_count?: number; - readonly url?: string; - }; - readonly repository_url?: string; - /** @enum {string} */ - readonly state: "closed" | "open"; - readonly timeline_url?: string; - readonly title?: string; - readonly updated_at?: string; - readonly url?: string; - readonly user?: { - readonly avatar_url?: string; - readonly events_url?: string; - readonly followers_url?: string; - readonly following_url?: string; - readonly gists_url?: string; - readonly gravatar_id?: string; - readonly html_url?: string; - /** Format: int64 */ - readonly id?: number; - readonly login?: string; - readonly node_id?: string; - readonly organizations_url?: string; - readonly received_events_url?: string; - readonly repos_url?: string; - readonly site_admin?: boolean; - readonly starred_url?: string; - readonly subscriptions_url?: string; - readonly type?: string; - readonly url?: string; - readonly user_view_type?: string; - }; }; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user"]; }; - /** issues deleted event */ - readonly "webhook-issues-deleted": { + /** issues demilestoned event */ + readonly "webhook-issues-demilestoned": { /** @enum {string} */ - readonly action: "deleted"; + readonly action: "demilestoned"; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; /** @@ -46227,10 +47285,9 @@ export interface components { /** Format: uri */ readonly subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; - readonly user_view_type?: string; } | null; readonly assignees: readonly ({ /** Format: uri */ @@ -46264,7 +47321,7 @@ export interface components { /** Format: uri */ readonly subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; } | null)[]; @@ -46290,7 +47347,7 @@ export interface components { readonly html_url: string; /** Format: int64 */ readonly id: number; - readonly labels?: readonly { + readonly labels?: readonly ({ /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; @@ -46304,7 +47361,7 @@ export interface components { * @description URL for the label */ readonly url: string; - }[]; + } | null)[]; /** Format: uri-template */ readonly labels_url: string; readonly locked?: boolean; @@ -46351,7 +47408,7 @@ export interface components { /** Format: uri */ readonly subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; readonly user_view_type?: string; @@ -46391,7 +47448,7 @@ export interface components { readonly created_at: string | null; readonly description: string | null; /** @description The list of events for the GitHub app */ - readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder")[]; + readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; /** Format: uri */ readonly external_url: string | null; /** Format: uri */ @@ -46476,7 +47533,7 @@ export interface components { /** @enum {string} */ readonly organization_plan?: "read" | "write"; /** @enum {string} */ - readonly organization_projects?: "read" | "write"; + readonly organization_projects?: "read" | "write" | "admin"; /** @enum {string} */ readonly organization_secrets?: "read" | "write"; /** @enum {string} */ @@ -46545,6 +47602,12 @@ export interface components { }; /** Format: uri */ readonly repository_url: string; + /** Sub-issues Summary */ + readonly sub_issues_summary?: { + readonly total: number; + readonly completed: number; + readonly percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -46596,20 +47659,32 @@ export interface components { /** Format: uri */ readonly subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; + readonly milestone?: components["schemas"]["webhooks_milestone"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user"]; }; - /** issues demilestoned event */ - readonly "webhook-issues-demilestoned": { + /** issues edited event */ + readonly "webhook-issues-edited": { /** @enum {string} */ - readonly action: "demilestoned"; + readonly action: "edited"; + /** @description The changes to the issue. */ + readonly changes: { + readonly body?: { + /** @description The previous version of the body. */ + readonly from: string; + }; + readonly title?: { + /** @description The previous version of the title. */ + readonly from: string; + }; + }; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; /** @@ -46655,6 +47730,7 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null; readonly assignees: readonly ({ /** Format: uri */ @@ -46714,7 +47790,7 @@ export interface components { readonly html_url: string; /** Format: int64 */ readonly id: number; - readonly labels?: readonly ({ + readonly labels?: readonly { /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; @@ -46728,7 +47804,7 @@ export interface components { * @description URL for the label */ readonly url: string; - } | null)[]; + }[]; /** Format: uri-template */ readonly labels_url: string; readonly locked?: boolean; @@ -46815,7 +47891,7 @@ export interface components { readonly created_at: string | null; readonly description: string | null; /** @description The list of events for the GitHub app */ - readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; + readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "security_and_analysis" | "pull_request_review_thread" | "reminder")[]; /** Format: uri */ readonly external_url: string | null; /** Format: uri */ @@ -46969,6 +48045,12 @@ export interface components { }; /** Format: uri */ readonly repository_url: string; + /** Sub-issues Summary */ + readonly sub_issues_summary?: { + readonly total: number; + readonly completed: number; + readonly percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -47026,26 +48108,15 @@ export interface components { readonly user_view_type?: string; } | null; }; - readonly milestone?: components["schemas"]["webhooks_milestone"]; + readonly label?: components["schemas"]["webhooks_label"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user"]; }; - /** issues edited event */ - readonly "webhook-issues-edited": { + /** issues labeled event */ + readonly "webhook-issues-labeled": { /** @enum {string} */ - readonly action: "edited"; - /** @description The changes to the issue. */ - readonly changes: { - readonly body?: { - /** @description The previous version of the body. */ - readonly from: string; - }; - readonly title?: { - /** @description The previous version of the title. */ - readonly from: string; - }; - }; + readonly action: "labeled"; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; /** @@ -47252,7 +48323,7 @@ export interface components { readonly created_at: string | null; readonly description: string | null; /** @description The list of events for the GitHub app */ - readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "security_and_analysis" | "pull_request_review_thread" | "reminder")[]; + readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "reminder")[]; /** Format: uri */ readonly external_url: string | null; /** Format: uri */ @@ -47406,6 +48477,12 @@ export interface components { }; /** Format: uri */ readonly repository_url: string; + /** Sub-issues Summary */ + readonly sub_issues_summary?: { + readonly total: number; + readonly completed: number; + readonly percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -47468,10 +48545,10 @@ export interface components { readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user"]; }; - /** issues labeled event */ - readonly "webhook-issues-labeled": { + /** issues locked event */ + readonly "webhook-issues-locked": { /** @enum {string} */ - readonly action: "labeled"; + readonly action: "locked"; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; /** @@ -47514,7 +48591,7 @@ export interface components { /** Format: uri */ readonly subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; readonly user_view_type?: string; @@ -47551,9 +48628,10 @@ export interface components { /** Format: uri */ readonly subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; + readonly user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -47577,7 +48655,7 @@ export interface components { readonly html_url: string; /** Format: int64 */ readonly id: number; - readonly labels?: readonly { + readonly labels?: readonly ({ /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; @@ -47591,10 +48669,11 @@ export interface components { * @description URL for the label */ readonly url: string; - }[]; + } | null)[]; /** Format: uri-template */ readonly labels_url: string; - readonly locked?: boolean; + /** @enum {boolean} */ + readonly locked: true; /** * Milestone * @description A collection of related issues and pull requests. @@ -47638,7 +48717,7 @@ export interface components { /** Format: uri */ readonly subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; readonly user_view_type?: string; @@ -47678,7 +48757,7 @@ export interface components { readonly created_at: string | null; readonly description: string | null; /** @description The list of events for the GitHub app */ - readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "reminder")[]; + readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "security_and_analysis")[]; /** Format: uri */ readonly external_url: string | null; /** Format: uri */ @@ -47763,7 +48842,7 @@ export interface components { /** @enum {string} */ readonly organization_plan?: "read" | "write"; /** @enum {string} */ - readonly organization_projects?: "read" | "write" | "admin"; + readonly organization_projects?: "read" | "write"; /** @enum {string} */ readonly organization_secrets?: "read" | "write"; /** @enum {string} */ @@ -47832,6 +48911,12 @@ export interface components { }; /** Format: uri */ readonly repository_url: string; + /** Sub-issues Summary */ + readonly sub_issues_summary?: { + readonly total: number; + readonly completed: number; + readonly percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -47883,21 +48968,20 @@ export interface components { /** Format: uri */ readonly subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; readonly user_view_type?: string; } | null; }; - readonly label?: components["schemas"]["webhooks_label"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user"]; }; - /** issues locked event */ - readonly "webhook-issues-locked": { + /** issues milestoned event */ + readonly "webhook-issues-milestoned": { /** @enum {string} */ - readonly action: "locked"; + readonly action: "milestoned"; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; /** @@ -47943,7 +49027,6 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; - readonly user_view_type?: string; } | null; readonly assignees: readonly ({ /** Format: uri */ @@ -47980,7 +49063,6 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; - readonly user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -48021,8 +49103,7 @@ export interface components { } | null)[]; /** Format: uri-template */ readonly labels_url: string; - /** @enum {boolean} */ - readonly locked: true; + readonly locked?: boolean; /** * Milestone * @description A collection of related issues and pull requests. @@ -48066,7 +49147,7 @@ export interface components { /** Format: uri */ readonly subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; readonly user_view_type?: string; @@ -48106,7 +49187,7 @@ export interface components { readonly created_at: string | null; readonly description: string | null; /** @description The list of events for the GitHub app */ - readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "security_and_analysis")[]; + readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder")[]; /** Format: uri */ readonly external_url: string | null; /** Format: uri */ @@ -48191,7 +49272,7 @@ export interface components { /** @enum {string} */ readonly organization_plan?: "read" | "write"; /** @enum {string} */ - readonly organization_projects?: "read" | "write"; + readonly organization_projects?: "read" | "write" | "admin"; /** @enum {string} */ readonly organization_secrets?: "read" | "write"; /** @enum {string} */ @@ -48260,430 +49341,12 @@ export interface components { }; /** Format: uri */ readonly repository_url: string; - /** - * @description State of the issue; either 'open' or 'closed' - * @enum {string} - */ - readonly state?: "open" | "closed"; - readonly state_reason?: string | null; - /** Format: uri */ - readonly timeline_url?: string; - /** @description Title of the issue */ - readonly title: string; - /** Format: date-time */ - readonly updated_at: string; - /** - * Format: uri - * @description URL for the issue - */ - readonly url: string; - /** User */ - readonly user: { - /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; - /** Format: uri-template */ - readonly events_url?: string; - /** Format: uri */ - readonly followers_url?: string; - /** Format: uri-template */ - readonly following_url?: string; - /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; - /** Format: uri */ - readonly html_url?: string; - /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; - /** Format: uri */ - readonly organizations_url?: string; - /** Format: uri */ - readonly received_events_url?: string; - /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; - /** Format: uri-template */ - readonly starred_url?: string; - /** Format: uri */ - readonly subscriptions_url?: string; - /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; - } | null; - }; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user"]; - }; - /** issues milestoned event */ - readonly "webhook-issues-milestoned": { - /** @enum {string} */ - readonly action: "milestoned"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - /** - * Issue - * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. - */ - readonly issue: { - /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ - readonly assignee?: { - /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; - /** Format: uri-template */ - readonly events_url?: string; - /** Format: uri */ - readonly followers_url?: string; - /** Format: uri-template */ - readonly following_url?: string; - /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; - /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; - /** Format: uri */ - readonly organizations_url?: string; - /** Format: uri */ - readonly received_events_url?: string; - /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; - /** Format: uri-template */ - readonly starred_url?: string; - /** Format: uri */ - readonly subscriptions_url?: string; - /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ - readonly url?: string; - } | null; - readonly assignees: readonly ({ - /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; - /** Format: uri-template */ - readonly events_url?: string; - /** Format: uri */ - readonly followers_url?: string; - /** Format: uri-template */ - readonly following_url?: string; - /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; - /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; - /** Format: uri */ - readonly organizations_url?: string; - /** Format: uri */ - readonly received_events_url?: string; - /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; - /** Format: uri-template */ - readonly starred_url?: string; - /** Format: uri */ - readonly subscriptions_url?: string; - /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ - readonly url?: string; - } | null)[]; - /** - * AuthorAssociation - * @description How the author is associated with the repository. - * @enum {string} - */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ - readonly body: string | null; - /** Format: date-time */ - readonly closed_at: string | null; - readonly comments: number; - /** Format: uri */ - readonly comments_url: string; - /** Format: date-time */ - readonly created_at: string; - readonly draft?: boolean; - /** Format: uri */ - readonly events_url: string; - /** Format: uri */ - readonly html_url: string; - /** Format: int64 */ - readonly id: number; - readonly labels?: readonly ({ - /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; - /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; - /** - * Format: uri - * @description URL for the label - */ - readonly url: string; - } | null)[]; - /** Format: uri-template */ - readonly labels_url: string; - readonly locked?: boolean; - /** - * Milestone - * @description A collection of related issues and pull requests. - */ - readonly milestone: { - /** Format: date-time */ - readonly closed_at: string | null; - readonly closed_issues: number; - /** Format: date-time */ - readonly created_at: string; - /** User */ - readonly creator: { - /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; - /** Format: uri-template */ - readonly events_url?: string; - /** Format: uri */ - readonly followers_url?: string; - /** Format: uri-template */ - readonly following_url?: string; - /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; - /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; - /** Format: uri */ - readonly organizations_url?: string; - /** Format: uri */ - readonly received_events_url?: string; - /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; - /** Format: uri-template */ - readonly starred_url?: string; - /** Format: uri */ - readonly subscriptions_url?: string; - /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; - } | null; - readonly description: string | null; - /** Format: date-time */ - readonly due_on: string | null; - /** Format: uri */ - readonly html_url: string; - readonly id: number; - /** Format: uri */ - readonly labels_url: string; - readonly node_id: string; - /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; - /** - * @description The state of the milestone. - * @enum {string} - */ - readonly state: "open" | "closed"; - /** @description The title of the milestone. */ - readonly title: string; - /** Format: date-time */ - readonly updated_at: string; - /** Format: uri */ - readonly url: string; - } | null; - readonly node_id: string; - readonly number: number; - /** - * App - * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. - */ - readonly performed_via_github_app?: { - /** Format: date-time */ - readonly created_at: string | null; - readonly description: string | null; - /** @description The list of events for the GitHub app */ - readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder")[]; - /** Format: uri */ - readonly external_url: string | null; - /** Format: uri */ - readonly html_url: string; - /** @description Unique identifier of the GitHub app */ - readonly id: number | null; - /** @description The name of the GitHub app */ - readonly name: string; - readonly node_id: string; - /** User */ - readonly owner: { - /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; - /** Format: uri-template */ - readonly events_url?: string; - /** Format: uri */ - readonly followers_url?: string; - /** Format: uri-template */ - readonly following_url?: string; - /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; - /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; - /** Format: uri */ - readonly organizations_url?: string; - /** Format: uri */ - readonly received_events_url?: string; - /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; - /** Format: uri-template */ - readonly starred_url?: string; - /** Format: uri */ - readonly subscriptions_url?: string; - /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; - } | null; - /** @description The set of permissions for the GitHub app */ - readonly permissions?: { - /** @enum {string} */ - readonly actions?: "read" | "write"; - /** @enum {string} */ - readonly administration?: "read" | "write"; - /** @enum {string} */ - readonly checks?: "read" | "write"; - /** @enum {string} */ - readonly content_references?: "read" | "write"; - /** @enum {string} */ - readonly contents?: "read" | "write"; - /** @enum {string} */ - readonly deployments?: "read" | "write"; - /** @enum {string} */ - readonly discussions?: "read" | "write"; - /** @enum {string} */ - readonly emails?: "read" | "write"; - /** @enum {string} */ - readonly environments?: "read" | "write"; - /** @enum {string} */ - readonly issues?: "read" | "write"; - /** @enum {string} */ - readonly keys?: "read" | "write"; - /** @enum {string} */ - readonly members?: "read" | "write"; - /** @enum {string} */ - readonly metadata?: "read" | "write"; - /** @enum {string} */ - readonly organization_administration?: "read" | "write"; - /** @enum {string} */ - readonly organization_hooks?: "read" | "write"; - /** @enum {string} */ - readonly organization_packages?: "read" | "write"; - /** @enum {string} */ - readonly organization_plan?: "read" | "write"; - /** @enum {string} */ - readonly organization_projects?: "read" | "write" | "admin"; - /** @enum {string} */ - readonly organization_secrets?: "read" | "write"; - /** @enum {string} */ - readonly organization_self_hosted_runners?: "read" | "write"; - /** @enum {string} */ - readonly organization_user_blocking?: "read" | "write"; - /** @enum {string} */ - readonly packages?: "read" | "write"; - /** @enum {string} */ - readonly pages?: "read" | "write"; - /** @enum {string} */ - readonly pull_requests?: "read" | "write"; - /** @enum {string} */ - readonly repository_hooks?: "read" | "write"; - /** @enum {string} */ - readonly repository_projects?: "read" | "write"; - /** @enum {string} */ - readonly secret_scanning_alerts?: "read" | "write"; - /** @enum {string} */ - readonly secrets?: "read" | "write"; - /** @enum {string} */ - readonly security_events?: "read" | "write"; - /** @enum {string} */ - readonly security_scanning_alert?: "read" | "write"; - /** @enum {string} */ - readonly single_file?: "read" | "write"; - /** @enum {string} */ - readonly statuses?: "read" | "write"; - /** @enum {string} */ - readonly team_discussions?: "read" | "write"; - /** @enum {string} */ - readonly vulnerability_alerts?: "read" | "write"; - /** @enum {string} */ - readonly workflows?: "read" | "write"; - }; - /** @description The slug name of the GitHub app */ - readonly slug?: string; - /** Format: date-time */ - readonly updated_at: string | null; - } | null; - readonly pull_request?: { - /** Format: uri */ - readonly diff_url?: string; - /** Format: uri */ - readonly html_url?: string; - /** Format: date-time */ - readonly merged_at?: string | null; - /** Format: uri */ - readonly patch_url?: string; - /** Format: uri */ - readonly url?: string; + /** Sub-issues Summary */ + readonly sub_issues_summary?: { + readonly total: number; + readonly completed: number; + readonly percent_completed: number; }; - /** Reactions */ - readonly reactions: { - readonly "+1": number; - readonly "-1": number; - readonly confused: number; - readonly eyes: number; - readonly heart: number; - readonly hooray: number; - readonly laugh: number; - readonly rocket: number; - readonly total_count: number; - /** Format: uri */ - readonly url: string; - }; - /** Format: uri */ - readonly repository_url: string; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -49110,6 +49773,12 @@ export interface components { }; /** Format: uri */ readonly repository_url: string; + /** Sub-issues Summary */ + readonly sub_issues_summary?: { + readonly total: number; + readonly completed: number; + readonly percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -49776,6 +50445,12 @@ export interface components { }; /** Format: uri */ readonly repository_url: string; + /** Sub-issues Summary */ + readonly sub_issues_summary?: { + readonly total: number; + readonly completed: number; + readonly percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -50211,6 +50886,12 @@ export interface components { }; /** Format: uri */ readonly repository_url: string; + /** Sub-issues Summary */ + readonly sub_issues_summary?: { + readonly total: number; + readonly completed: number; + readonly percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -50636,6 +51317,12 @@ export interface components { }; /** Format: uri */ readonly repository_url: string; + /** Sub-issues Summary */ + readonly sub_issues_summary?: { + readonly total: number; + readonly completed: number; + readonly percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -51344,6 +52031,12 @@ export interface components { }; /** Format: uri */ readonly repository_url: string; + /** Sub-issues Summary */ + readonly sub_issues_summary?: { + readonly total: number; + readonly completed: number; + readonly percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -82571,6 +83264,45 @@ export interface components { readonly repository: components["schemas"]["repository-webhooks"]; readonly sender?: components["schemas"]["simple-user"]; }; + /** secret_scanning_scan completed event */ + readonly "webhook-secret-scanning-scan-completed": { + /** @enum {string} */ + readonly action: "completed"; + /** + * @description What type of scan was completed + * @enum {string} + */ + readonly type: "backfill" | "custom-pattern-backfill" | "pattern-version-backfill"; + /** + * @description What type of content was scanned + * @enum {string} + */ + readonly source: "git" | "issues" | "pull-requests" | "discussions" | "wiki"; + /** + * Format: date-time + * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + readonly started_at: string; + /** + * Format: date-time + * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + readonly completed_at: string; + /** @description List of patterns that were updated. This will be empty for normal backfill scans or custom pattern updates */ + readonly secret_types?: readonly string[] | null; + /** @description If the scan was triggered by a custom pattern update, this will be the name of the pattern that was updated */ + readonly custom_pattern_name?: string | null; + /** + * @description If the scan was triggered by a custom pattern update, this will be the scope of the pattern that was updated + * @enum {string|null} + */ + readonly custom_pattern_scope?: "repository" | "organization" | "enterprise" | null; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly sender?: components["schemas"]["simple-user"]; + }; /** security_advisory published event */ readonly "webhook-security-advisory-published": { /** @enum {string} */ @@ -82850,6 +83582,7 @@ export interface components { readonly reason: "expired_key" | "not_signing_key" | "gpgverify_error" | "gpgverify_unavailable" | "unsigned" | "unknown_signature_type" | "no_user" | "unverified_email" | "bad_email" | "unknown_key" | "malformed_signature" | "invalid" | "valid" | "bad_cert" | "ocsp_pending"; readonly signature: string | null; readonly verified: boolean; + readonly verified_at?: string | null; }; }; /** User */ @@ -86045,8 +86778,8 @@ export interface components { readonly "application/json": components["schemas"]["basic-error"]; }; }; - /** @description Internal Error */ - readonly internal_error: { + /** @description Conflict */ + readonly conflict: { headers: { readonly [name: string]: unknown; }; @@ -86054,14 +86787,12 @@ export interface components { readonly "application/json": components["schemas"]["basic-error"]; }; }; - /** @description Copilot Usage Merics API setting is disabled at the organization or enterprise level. */ - readonly usage_metrics_api_disabled: { + /** @description A header with no content is returned. */ + readonly no_content: { headers: { readonly [name: string]: unknown; }; - content: { - readonly "application/json": components["schemas"]["basic-error"]; - }; + content?: never; }; /** @description Service unavailable */ readonly service_unavailable: { @@ -86102,8 +86833,17 @@ export interface components { readonly "application/json": components["schemas"]["basic-error"]; }; }; - /** @description Conflict */ - readonly conflict: { + /** @description Billing usage report response for an organization */ + readonly billing_usage_report_org: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["billing-usage-report"]; + }; + }; + /** @description Internal Error */ + readonly internal_error: { headers: { readonly [name: string]: unknown; }; @@ -86148,12 +86888,14 @@ export interface components { }; }; }; - /** @description A header with no content is returned. */ - readonly no_content: { + /** @description Copilot Usage Merics API setting is disabled at the organization or enterprise level. */ + readonly usage_metrics_api_disabled: { headers: { readonly [name: string]: unknown; }; - content?: never; + content: { + readonly "application/json": components["schemas"]["basic-error"]; + }; }; /** @description The value of `per_page` multiplied by `page` cannot be greater than 10000. */ readonly package_es_list_error: { @@ -86198,6 +86940,24 @@ export interface components { readonly "application/json": components["schemas"]["basic-error"]; }; }; + /** @description Bad Request */ + readonly code_scanning_bad_request: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["basic-error"]; + }; + }; + /** @description Response if the repository is archived, if GitHub Advanced Security is not enabled for this repository or if rate limit is exceeded */ + readonly code_scanning_autofix_create_forbidden: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["basic-error"]; + }; + }; /** @description Found */ readonly found: { headers: { @@ -86271,6 +87031,8 @@ export interface components { readonly "classroom-id": number; /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ readonly enterprise: string; + /** @description The unique identifier of the code security configuration. */ + readonly "configuration-id": number; /** @description A comma-separated list of states. If specified, only alerts with these states will be returned. * * Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` */ @@ -86301,9 +87063,7 @@ export interface components { readonly "pagination-last": number; /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ readonly "secret-scanning-alert-state": "open" | "resolved"; - /** @description A comma-separated list of secret types to return. By default all secret types are returned. - * See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" - * for a complete list of secret types. */ + /** @description A comma-separated list of secret types to return. All default secret patterns are returned. To return experimental patterns, pass the token name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. */ readonly "secret-scanning-alert-secret-type": string; /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ readonly "secret-scanning-alert-resolution": string; @@ -86315,10 +87075,6 @@ export interface components { readonly "secret-scanning-alert-publicly-leaked": boolean; /** @description A boolean value representing whether or not to filter alerts by the multi-repo tag being present. */ readonly "secret-scanning-alert-multi-repo": boolean; - /** @description The slug of the enterprise team name. */ - readonly "enterprise-team-slug": string; - /** @description The slug of the team name. */ - readonly "team-slug": string; /** @description The unique identifier of the gist. */ readonly "gist-id": string; /** @description The unique identifier of the comment. */ @@ -86347,6 +87103,14 @@ export interface components { readonly "since-org": number; /** @description The organization name. The name is not case sensitive. */ readonly org: string; + /** @description If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2024`. Default value is the current year. */ + readonly "billing-usage-report-year": number; + /** @description If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. */ + readonly "billing-usage-report-month": number; + /** @description If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. */ + readonly "billing-usage-report-day": number; + /** @description If specified, only return results for a single hour. The value of `hour` is an integer between `0` and `23`. */ + readonly "billing-usage-report-hour": number; /** @description The unique identifier of the repository. */ readonly "repository-id": number; /** @description Only return runner groups that are allowed to be used by this repository. */ @@ -86369,26 +87133,30 @@ export interface components { readonly "tool-name": components["schemas"]["code-scanning-analysis-tool-name"]; /** @description The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both. */ readonly "tool-guid": components["schemas"]["code-scanning-analysis-tool-guid"]; - /** @description The unique identifier of the code security configuration. */ - readonly "configuration-id": number; /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ readonly "hook-id": number; /** @description The type of the actor */ - readonly "api-insights-actor-type": "installations" | "classic_pats" | "fine_grained_pats" | "oauth_apps" | "github_apps_user_to_server"; + readonly "api-insights-actor-type": "installation" | "classic_pat" | "fine_grained_pat" | "oauth_app" | "github_app_user_to_server"; /** @description The ID of the actor */ readonly "api-insights-actor-id": number; - /** @description The minimum timestamp to query for stats */ + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ readonly "api-insights-min-timestamp": string; - /** @description The maximum timestamp to query for stats */ + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ readonly "api-insights-max-timestamp": string; /** @description The property to sort the results by. */ readonly "api-insights-route-stats-sort": readonly ("last_rate_limited_timestamp" | "last_request_timestamp" | "rate_limited_request_count" | "http_method" | "api_route" | "total_request_count")[]; + /** @description Providing a substring will filter results where the API route contains the substring. This is a case-insensitive search. */ + readonly "api-insights-api-route-substring": string; /** @description The property to sort the results by. */ readonly "api-insights-sort": readonly ("last_rate_limited_timestamp" | "last_request_timestamp" | "rate_limited_request_count" | "subject_name" | "total_request_count")[]; + /** @description Providing a substring will filter results where the subject name contains the substring. This is a case-insensitive search. */ + readonly "api-insights-subject-name-substring": string; /** @description The ID of the user to query for stats */ readonly "api-insights-user-id": string; /** @description The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) */ readonly "api-insights-timestamp-increment": string; + /** @description Providing a substring will filter results where the actor name contains the substring. This is a case-insensitive search. */ + readonly "api-insights-actor-name-substring": string; /** @description The unique identifier of the invitation. */ readonly "invitation-id": number; /** @description The name of the codespace. */ @@ -86397,6 +87165,8 @@ export interface components { readonly "migration-id": number; /** @description repo_name parameter */ readonly "repo-name": string; + /** @description The slug of the team name. */ + readonly "team-slug": string; /** @description The unique identifier of the role. */ readonly "role-id": number; /** @description The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -86433,8 +87203,8 @@ export interface components { readonly "ruleset-targets": string; /** @description The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. */ readonly "ref-in-query": string; - /** @description The name of the repository to filter on. When specified, only rule evaluations from this repository will be returned. */ - readonly "repository-name-in-query": number; + /** @description The name of the repository to filter on. */ + readonly "repository-name-in-query": string; /** @description The time period to filter by. * * For example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for insights that occurred in the past 7 days (168 hours). */ @@ -87519,13 +88289,15 @@ export interface operations { readonly 304: components["responses"]["not_modified"]; }; }; - readonly "copilot/list-copilot-seats-for-enterprise": { + readonly "code-security/get-configurations-for-enterprise": { readonly parameters: { readonly query?: { - /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - readonly page?: components["parameters"]["page"]; /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ readonly per_page?: number; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly before?: components["parameters"]["pagination-before"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly after?: components["parameters"]["pagination-after"]; }; readonly header?: never; readonly path: { @@ -87539,39 +88311,164 @@ export interface operations { /** @description Response */ readonly 200: { headers: { - readonly Link: components["headers"]["link"]; readonly [name: string]: unknown; }; content: { - readonly "application/json": { - /** @description The total number of Copilot seats the enterprise is being billed for. Users with access through multiple organizations or enterprise teams are only counted once. */ - readonly total_seats?: number; - readonly seats?: readonly components["schemas"]["copilot-seat-details"][]; + readonly "application/json": readonly components["schemas"]["code-security-configuration"][]; + }; + }; + readonly 403: components["responses"]["forbidden"]; + readonly 404: components["responses"]["not_found"]; + }; + }; + readonly "code-security/create-configuration-for-enterprise": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + readonly enterprise: components["parameters"]["enterprise"]; + }; + readonly cookie?: never; + }; + readonly requestBody: { + readonly content: { + readonly "application/json": { + /** @description The name of the code security configuration. Must be unique within the enterprise. */ + readonly name: string; + /** @description A description of the code security configuration */ + readonly description: string; + /** + * @description The enablement status of GitHub Advanced Security + * @default disabled + * @enum {string} + */ + readonly advanced_security?: "enabled" | "disabled"; + /** + * @description The enablement status of Dependency Graph + * @default enabled + * @enum {string} + */ + readonly dependency_graph?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Automatic dependency submission + * @default disabled + * @enum {string} + */ + readonly dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for Automatic dependency submission */ + readonly dependency_graph_autosubmit_action_options?: { + /** + * @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. + * @default false + */ + readonly labeled_runners?: boolean; }; + /** + * @description The enablement status of Dependabot alerts + * @default disabled + * @enum {string} + */ + readonly dependabot_alerts?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot security updates + * @default disabled + * @enum {string} + */ + readonly dependabot_security_updates?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of code scanning default setup + * @default disabled + * @enum {string} + */ + readonly code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; + readonly code_scanning_default_setup_options?: components["schemas"]["code-scanning-default-setup-options"]; + /** + * @description The enablement status of secret scanning + * @default disabled + * @enum {string} + */ + readonly secret_scanning?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning push protection + * @default disabled + * @enum {string} + */ + readonly secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning validity checks + * @default disabled + * @enum {string} + */ + readonly secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning non provider patterns + * @default disabled + * @enum {string} + */ + readonly secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of private vulnerability reporting + * @default disabled + * @enum {string} + */ + readonly private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; + /** + * @description The enforcement status for a security configuration + * @default enforced + * @enum {string} + */ + readonly enforcement?: "enforced" | "unenforced"; }; }; - readonly 401: components["responses"]["requires_authentication"]; + }; + readonly responses: { + /** @description Successfully created code security configuration */ + readonly 201: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["code-security-configuration"]; + }; + }; + readonly 400: components["responses"]["bad_request"]; readonly 403: components["responses"]["forbidden"]; readonly 404: components["responses"]["not_found"]; - readonly 500: components["responses"]["internal_error"]; }; }; - readonly "copilot/copilot-metrics-for-enterprise": { + readonly "code-security/get-default-configurations-for-enterprise": { readonly parameters: { - readonly query?: { - /** @description Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago. */ - readonly since?: string; - /** @description Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed. */ - readonly until?: string; - /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - readonly page?: components["parameters"]["page"]; - /** @description The number of days of metrics to display per page (max 28). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - readonly per_page?: number; + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + readonly enterprise: components["parameters"]["enterprise"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["code-security-default-configurations"]; + }; }; + }; + }; + readonly "code-security/get-single-configuration-for-enterprise": { + readonly parameters: { + readonly query?: never; readonly header?: never; readonly path: { /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ readonly enterprise: components["parameters"]["enterprise"]; + /** @description The unique identifier of the code security configuration. */ + readonly configuration_id: components["parameters"]["configuration-id"]; }; readonly cookie?: never; }; @@ -87583,31 +88480,233 @@ export interface operations { readonly [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["copilot-usage-metrics-day"][]; + readonly "application/json": components["schemas"]["code-security-configuration"]; }; }; + readonly 304: components["responses"]["not_modified"]; readonly 403: components["responses"]["forbidden"]; readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["usage_metrics_api_disabled"]; - readonly 500: components["responses"]["internal_error"]; }; }; - readonly "copilot/usage-metrics-for-enterprise": { + readonly "code-security/delete-configuration-for-enterprise": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + readonly enterprise: components["parameters"]["enterprise"]; + /** @description The unique identifier of the code security configuration. */ + readonly configuration_id: components["parameters"]["configuration-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + readonly 204: components["responses"]["no_content"]; + readonly 400: components["responses"]["bad_request"]; + readonly 403: components["responses"]["forbidden"]; + readonly 404: components["responses"]["not_found"]; + readonly 409: components["responses"]["conflict"]; + }; + }; + readonly "code-security/update-enterprise-configuration": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + readonly enterprise: components["parameters"]["enterprise"]; + /** @description The unique identifier of the code security configuration. */ + readonly configuration_id: components["parameters"]["configuration-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody: { + readonly content: { + readonly "application/json": { + /** @description The name of the code security configuration. Must be unique across the enterprise. */ + readonly name?: string; + /** @description A description of the code security configuration */ + readonly description?: string; + /** + * @description The enablement status of GitHub Advanced Security. Must be set to enabled if you want to enable any GHAS settings. + * @enum {string} + */ + readonly advanced_security?: "enabled" | "disabled"; + /** + * @description The enablement status of Dependency Graph + * @enum {string} + */ + readonly dependency_graph?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Automatic dependency submission + * @enum {string} + */ + readonly dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for Automatic dependency submission */ + readonly dependency_graph_autosubmit_action_options?: { + /** @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. */ + readonly labeled_runners?: boolean; + }; + /** + * @description The enablement status of Dependabot alerts + * @enum {string} + */ + readonly dependabot_alerts?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot security updates + * @enum {string} + */ + readonly dependabot_security_updates?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of code scanning default setup + * @enum {string} + */ + readonly code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; + readonly code_scanning_default_setup_options?: components["schemas"]["code-scanning-default-setup-options"]; + /** + * @description The enablement status of secret scanning + * @enum {string} + */ + readonly secret_scanning?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning push protection + * @enum {string} + */ + readonly secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning validity checks + * @enum {string} + */ + readonly secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning non-provider patterns + * @enum {string} + */ + readonly secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of private vulnerability reporting + * @enum {string} + */ + readonly private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; + /** + * @description The enforcement status for a security configuration + * @enum {string} + */ + readonly enforcement?: "enforced" | "unenforced"; + }; + }; + }; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["code-security-configuration"]; + }; + }; + readonly 304: components["responses"]["not_modified"]; + readonly 403: components["responses"]["forbidden"]; + readonly 404: components["responses"]["not_found"]; + readonly 409: components["responses"]["conflict"]; + }; + }; + readonly "code-security/attach-enterprise-configuration": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + readonly enterprise: components["parameters"]["enterprise"]; + /** @description The unique identifier of the code security configuration. */ + readonly configuration_id: components["parameters"]["configuration-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody: { + readonly content: { + readonly "application/json": { + /** + * @description The type of repositories to attach the configuration to. `selected` means the configuration will be attached to only the repositories specified by `selected_repository_ids` + * @enum {string} + */ + readonly scope: "all" | "all_without_configurations"; + }; + }; + }; + readonly responses: { + readonly 202: components["responses"]["accepted"]; + readonly 403: components["responses"]["forbidden"]; + readonly 404: components["responses"]["not_found"]; + readonly 409: components["responses"]["conflict"]; + }; + }; + readonly "code-security/set-configuration-as-default-for-enterprise": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + readonly enterprise: components["parameters"]["enterprise"]; + /** @description The unique identifier of the code security configuration. */ + readonly configuration_id: components["parameters"]["configuration-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody: { + readonly content: { + readonly "application/json": { + /** + * @description Specify which types of repository this security configuration should be applied to by default. + * @enum {string} + */ + readonly default_for_new_repos?: "all" | "none" | "private_and_internal" | "public"; + }; + }; + }; + readonly responses: { + /** @description Default successfully changed. */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** + * @description Specifies which types of repository this security configuration is applied to by default. + * @enum {string} + */ + readonly default_for_new_repos?: "all" | "none" | "private_and_internal" | "public"; + readonly configuration?: components["schemas"]["code-security-configuration"]; + }; + }; + }; + readonly 403: components["responses"]["forbidden"]; + readonly 404: components["responses"]["not_found"]; + }; + }; + readonly "code-security/get-repositories-for-enterprise-configuration": { readonly parameters: { readonly query?: { - /** @description Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago. */ - readonly since?: string; - /** @description Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed. */ - readonly until?: string; - /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - readonly page?: components["parameters"]["page"]; - /** @description The number of days of metrics to display per page (max 28). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ readonly per_page?: number; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly before?: components["parameters"]["pagination-before"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly after?: components["parameters"]["pagination-after"]; + /** @description A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned. + * + * Can be: `all`, `attached`, `attaching`, `removed`, `enforced`, `failed`, `updating`, `removed_by_enterprise` */ + readonly status?: string; }; readonly header?: never; readonly path: { /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ readonly enterprise: components["parameters"]["enterprise"]; + /** @description The unique identifier of the code security configuration. */ + readonly configuration_id: components["parameters"]["configuration-id"]; }; readonly cookie?: never; }; @@ -87619,13 +88718,11 @@ export interface operations { readonly [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["copilot-usage-metrics"][]; + readonly "application/json": readonly components["schemas"]["code-security-configuration-repositories"][]; }; }; - readonly 401: components["responses"]["requires_authentication"]; readonly 403: components["responses"]["forbidden"]; readonly 404: components["responses"]["not_found"]; - readonly 500: components["responses"]["internal_error"]; }; }; readonly "dependabot/list-alerts-for-enterprise": { @@ -87697,9 +88794,7 @@ export interface operations { readonly query?: { /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ readonly state?: components["parameters"]["secret-scanning-alert-state"]; - /** @description A comma-separated list of secret types to return. By default all secret types are returned. - * See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" - * for a complete list of secret types. */ + /** @description A comma-separated list of secret types to return. All default secret patterns are returned. To return experimental patterns, pass the token name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. */ readonly secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ readonly resolution?: components["parameters"]["secret-scanning-alert-resolution"]; @@ -87743,82 +88838,6 @@ export interface operations { readonly 503: components["responses"]["service_unavailable"]; }; }; - readonly "copilot/copilot-metrics-for-enterprise-team": { - readonly parameters: { - readonly query?: { - /** @description Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago. */ - readonly since?: string; - /** @description Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed. */ - readonly until?: string; - /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - readonly page?: components["parameters"]["page"]; - /** @description The number of days of metrics to display per page (max 28). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - readonly per_page?: number; - }; - readonly header?: never; - readonly path: { - /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - readonly enterprise: components["parameters"]["enterprise"]; - /** @description The slug of the enterprise team name. */ - readonly team_slug: components["parameters"]["enterprise-team-slug"]; - }; - readonly cookie?: never; - }; - readonly requestBody?: never; - readonly responses: { - /** @description Response */ - readonly 200: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": readonly components["schemas"]["copilot-usage-metrics-day"][]; - }; - }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["usage_metrics_api_disabled"]; - readonly 500: components["responses"]["internal_error"]; - }; - }; - readonly "copilot/usage-metrics-for-enterprise-team": { - readonly parameters: { - readonly query?: { - /** @description Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago. */ - readonly since?: string; - /** @description Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed. */ - readonly until?: string; - /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - readonly page?: components["parameters"]["page"]; - /** @description The number of days of metrics to display per page (max 28). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - readonly per_page?: number; - }; - readonly header?: never; - readonly path: { - /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - readonly enterprise: components["parameters"]["enterprise"]; - /** @description The slug of the team name. */ - readonly team_slug: components["parameters"]["team-slug"]; - }; - readonly cookie?: never; - }; - readonly requestBody?: never; - readonly responses: { - /** @description Response */ - readonly 200: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": readonly components["schemas"]["copilot-usage-metrics"][]; - }; - }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 500: components["responses"]["internal_error"]; - }; - }; readonly "activity/list-public-events": { readonly parameters: { readonly query?: { @@ -89271,6 +90290,34 @@ export interface operations { readonly 304: components["responses"]["not_modified"]; }; }; + readonly "billing/get-github-billing-usage-report-org": { + readonly parameters: { + readonly query?: { + /** @description If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2024`. Default value is the current year. */ + readonly year?: components["parameters"]["billing-usage-report-year"]; + /** @description If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. */ + readonly month?: components["parameters"]["billing-usage-report-month"]; + /** @description If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. */ + readonly day?: components["parameters"]["billing-usage-report-day"]; + /** @description If specified, only return results for a single hour. The value of `hour` is an integer between `0` and `23`. */ + readonly hour?: components["parameters"]["billing-usage-report-hour"]; + }; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + readonly 200: components["responses"]["billing_usage_report_org"]; + readonly 400: components["responses"]["bad_request"]; + readonly 403: components["responses"]["forbidden"]; + readonly 500: components["responses"]["internal_error"]; + readonly 503: components["responses"]["service_unavailable"]; + }; + }; readonly "orgs/get": { readonly parameters: { readonly query?: never; @@ -91166,6 +92213,7 @@ export interface operations { }; }; readonly repository_id?: number; + readonly bundle_url?: string; }[]; }; }; @@ -91421,6 +92469,7 @@ export interface operations { * @enum {string} */ readonly code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; + readonly code_scanning_default_setup_options?: components["schemas"]["code-scanning-default-setup-options"]; /** * @description The enablement status of secret scanning * @default disabled @@ -91646,6 +92695,7 @@ export interface operations { * @enum {string} */ readonly code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; + readonly code_scanning_default_setup_options?: components["schemas"]["code-scanning-default-setup-options"]; /** * @description The enablement status of secret scanning * @enum {string} @@ -93373,10 +94423,10 @@ export interface operations { readonly "api-insights/get-route-stats-by-actor": { readonly parameters: { readonly query: { - /** @description The minimum timestamp to query for stats */ + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ readonly min_timestamp: components["parameters"]["api-insights-min-timestamp"]; - /** @description The maximum timestamp to query for stats */ - readonly max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + readonly max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ readonly page?: components["parameters"]["page"]; /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ @@ -93385,6 +94435,8 @@ export interface operations { readonly direction?: components["parameters"]["direction"]; /** @description The property to sort the results by. */ readonly sort?: components["parameters"]["api-insights-route-stats-sort"]; + /** @description Providing a substring will filter results where the API route contains the substring. This is a case-insensitive search. */ + readonly api_route_substring?: components["parameters"]["api-insights-api-route-substring"]; }; readonly header?: never; readonly path: { @@ -93413,10 +94465,10 @@ export interface operations { readonly "api-insights/get-subject-stats": { readonly parameters: { readonly query: { - /** @description The minimum timestamp to query for stats */ + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ readonly min_timestamp: components["parameters"]["api-insights-min-timestamp"]; - /** @description The maximum timestamp to query for stats */ - readonly max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + readonly max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ readonly page?: components["parameters"]["page"]; /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ @@ -93425,6 +94477,8 @@ export interface operations { readonly direction?: components["parameters"]["direction"]; /** @description The property to sort the results by. */ readonly sort?: components["parameters"]["api-insights-sort"]; + /** @description Providing a substring will filter results where the subject name contains the substring. This is a case-insensitive search. */ + readonly subject_name_substring?: components["parameters"]["api-insights-subject-name-substring"]; }; readonly header?: never; readonly path: { @@ -93449,10 +94503,10 @@ export interface operations { readonly "api-insights/get-summary-stats": { readonly parameters: { readonly query: { - /** @description The minimum timestamp to query for stats */ + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ readonly min_timestamp: components["parameters"]["api-insights-min-timestamp"]; - /** @description The maximum timestamp to query for stats */ - readonly max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + readonly max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; }; readonly header?: never; readonly path: { @@ -93477,10 +94531,10 @@ export interface operations { readonly "api-insights/get-summary-stats-by-user": { readonly parameters: { readonly query: { - /** @description The minimum timestamp to query for stats */ + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ readonly min_timestamp: components["parameters"]["api-insights-min-timestamp"]; - /** @description The maximum timestamp to query for stats */ - readonly max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + readonly max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; }; readonly header?: never; readonly path: { @@ -93507,10 +94561,10 @@ export interface operations { readonly "api-insights/get-summary-stats-by-actor": { readonly parameters: { readonly query: { - /** @description The minimum timestamp to query for stats */ + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ readonly min_timestamp: components["parameters"]["api-insights-min-timestamp"]; - /** @description The maximum timestamp to query for stats */ - readonly max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + readonly max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; }; readonly header?: never; readonly path: { @@ -93539,10 +94593,10 @@ export interface operations { readonly "api-insights/get-time-stats": { readonly parameters: { readonly query: { - /** @description The minimum timestamp to query for stats */ + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ readonly min_timestamp: components["parameters"]["api-insights-min-timestamp"]; - /** @description The maximum timestamp to query for stats */ - readonly max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + readonly max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; /** @description The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) */ readonly timestamp_increment: components["parameters"]["api-insights-timestamp-increment"]; }; @@ -93569,10 +94623,10 @@ export interface operations { readonly "api-insights/get-time-stats-by-user": { readonly parameters: { readonly query: { - /** @description The minimum timestamp to query for stats */ + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ readonly min_timestamp: components["parameters"]["api-insights-min-timestamp"]; - /** @description The maximum timestamp to query for stats */ - readonly max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + readonly max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; /** @description The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) */ readonly timestamp_increment: components["parameters"]["api-insights-timestamp-increment"]; }; @@ -93601,10 +94655,10 @@ export interface operations { readonly "api-insights/get-time-stats-by-actor": { readonly parameters: { readonly query: { - /** @description The minimum timestamp to query for stats */ + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ readonly min_timestamp: components["parameters"]["api-insights-min-timestamp"]; - /** @description The maximum timestamp to query for stats */ - readonly max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + readonly max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; /** @description The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) */ readonly timestamp_increment: components["parameters"]["api-insights-timestamp-increment"]; }; @@ -93635,10 +94689,10 @@ export interface operations { readonly "api-insights/get-user-stats": { readonly parameters: { readonly query: { - /** @description The minimum timestamp to query for stats */ + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ readonly min_timestamp: components["parameters"]["api-insights-min-timestamp"]; - /** @description The maximum timestamp to query for stats */ - readonly max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + readonly max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ readonly page?: components["parameters"]["page"]; /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ @@ -93647,6 +94701,8 @@ export interface operations { readonly direction?: components["parameters"]["direction"]; /** @description The property to sort the results by. */ readonly sort?: components["parameters"]["api-insights-sort"]; + /** @description Providing a substring will filter results where the actor name contains the substring. This is a case-insensitive search. */ + readonly actor_name_substring?: components["parameters"]["api-insights-actor-name-substring"]; }; readonly header?: never; readonly path: { @@ -95515,6 +96571,223 @@ export interface operations { readonly 500: components["responses"]["internal_error"]; }; }; + readonly "private-registries/list-org-private-registries": { + readonly parameters: { + readonly query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly page?: components["parameters"]["page"]; + }; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly Link: components["headers"]["link"]; + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + readonly total_count: number; + readonly configurations: readonly components["schemas"]["org-private-registry-configuration"][]; + }; + }; + }; + readonly 400: components["responses"]["bad_request"]; + readonly 404: components["responses"]["not_found"]; + }; + }; + readonly "private-registries/create-org-private-registry": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + }; + readonly cookie?: never; + }; + readonly requestBody: { + readonly content: { + readonly "application/json": { + /** + * @description The registry type. + * @enum {string} + */ + readonly registry_type: "maven_repository"; + /** @description The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication. */ + readonly username?: string | null; + /** @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint. */ + readonly encrypted_value: string; + /** @description The ID of the key you used to encrypt the secret. */ + readonly key_id: string; + /** + * @description Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry. + * @enum {string} + */ + readonly visibility: "all" | "private" | "selected"; + /** @description An array of repository IDs that can access the organization private registry. You can only provide a list of repository IDs when `visibility` is set to `selected`. You can manage the list of selected repositories using the [Update a private registry for an organization](https://docs.github.com/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization) endpoint. This field should be omitted if `visibility` is set to `all` or `private`. */ + readonly selected_repository_ids?: readonly number[]; + }; + }; + }; + readonly responses: { + /** @description The organization private registry configuration */ + readonly 201: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["org-private-registry-configuration-with-selected-repositories"]; + }; + }; + readonly 404: components["responses"]["not_found"]; + readonly 422: components["responses"]["validation_failed"]; + }; + }; + readonly "private-registries/get-org-public-key": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly Link: components["headers"]["link"]; + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** + * @description The identifier for the key. + * @example 012345678912345678 + */ + readonly key_id: string; + /** + * @description The Base64 encoded public key. + * @example 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 + */ + readonly key: string; + }; + }; + }; + readonly 404: components["responses"]["not_found"]; + }; + }; + readonly "private-registries/get-org-private-registry": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + /** @description The name of the secret. */ + readonly secret_name: components["parameters"]["secret-name"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description The specified private registry configuration for the organization */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["org-private-registry-configuration"]; + }; + }; + readonly 404: components["responses"]["not_found"]; + }; + }; + readonly "private-registries/delete-org-private-registry": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + /** @description The name of the secret. */ + readonly secret_name: components["parameters"]["secret-name"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 204: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + readonly 400: components["responses"]["bad_request"]; + readonly 404: components["responses"]["not_found"]; + }; + }; + readonly "private-registries/update-org-private-registry": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + /** @description The name of the secret. */ + readonly secret_name: components["parameters"]["secret-name"]; + }; + readonly cookie?: never; + }; + readonly requestBody: { + readonly content: { + readonly "application/json": { + /** + * @description The registry type. + * @enum {string} + */ + readonly registry_type?: "maven_repository"; + /** @description The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication. */ + readonly username?: string | null; + /** @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint. */ + readonly encrypted_value?: string; + /** @description The ID of the key you used to encrypt the secret. */ + readonly key_id?: string; + /** + * @description Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry. + * @enum {string} + */ + readonly visibility?: "all" | "private" | "selected"; + /** @description An array of repository IDs that can access the organization private registry. You can only provide a list of repository IDs when `visibility` is set to `selected`. This field should be omitted if `visibility` is set to `all` or `private`. */ + readonly selected_repository_ids?: readonly number[]; + }; + }; + }; + readonly responses: { + /** @description Response */ + readonly 204: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + readonly 404: components["responses"]["not_found"]; + readonly 422: components["responses"]["validation_failed"]; + }; + }; readonly "projects/list-for-org": { readonly parameters: { readonly query?: { @@ -95682,23 +96955,7 @@ export interface operations { }; readonly requestBody: { readonly content: { - readonly "application/json": { - /** - * @description The type of the value for the property - * @example single_select - * @enum {string} - */ - readonly value_type: "string" | "single_select" | "multi_select" | "true_false"; - /** @description Whether the property is required. */ - readonly required?: boolean; - /** @description Default value of the property */ - readonly default_value?: (string | readonly string[]) | null; - /** @description Short description of the property */ - readonly description?: string | null; - /** @description An ordered list of the allowed values of the property. - * The property can have up to 200 allowed values. */ - readonly allowed_values?: readonly string[] | null; - }; + readonly "application/json": components["schemas"]["custom-property-set-payload"]; }; }; readonly responses: { @@ -96155,7 +97412,7 @@ export interface operations { * @default branch * @enum {string} */ - readonly target?: "branch" | "tag" | "push"; + readonly target?: "branch" | "tag" | "push" | "repository"; readonly enforcement: components["schemas"]["repository-rule-enforcement"]; /** @description The actors that can bypass the rules in this ruleset */ readonly bypass_actors?: readonly components["schemas"]["repository-ruleset-bypass-actor"][]; @@ -96184,7 +97441,7 @@ export interface operations { readonly query?: { /** @description The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. */ readonly ref?: components["parameters"]["ref-in-query"]; - /** @description The name of the repository to filter on. When specified, only rule evaluations from this repository will be returned. */ + /** @description The name of the repository to filter on. */ readonly repository_name?: components["parameters"]["repository-name-in-query"]; /** @description The time period to filter by. * @@ -96300,7 +97557,7 @@ export interface operations { * @description The target of the ruleset * @enum {string} */ - readonly target?: "branch" | "tag" | "push"; + readonly target?: "branch" | "tag" | "push" | "repository"; readonly enforcement?: components["schemas"]["repository-rule-enforcement"]; /** @description The actors that can bypass the rules in this ruleset */ readonly bypass_actors?: readonly components["schemas"]["repository-ruleset-bypass-actor"][]; @@ -96354,9 +97611,7 @@ export interface operations { readonly query?: { /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ readonly state?: components["parameters"]["secret-scanning-alert-state"]; - /** @description A comma-separated list of secret types to return. By default all secret types are returned. - * See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" - * for a complete list of secret types. */ + /** @description A comma-separated list of secret types to return. All default secret patterns are returned. To return experimental patterns, pass the token name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. */ readonly secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ readonly resolution?: components["parameters"]["secret-scanning-alert-resolution"]; @@ -101375,6 +102630,7 @@ export interface operations { }; }; readonly repository_id?: number; + readonly bundle_url?: string; }[]; }; }; @@ -103463,6 +104719,126 @@ export interface operations { readonly 503: components["responses"]["service_unavailable"]; }; }; + readonly "code-scanning/get-autofix": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The account owner of the repository. The name is not case sensitive. */ + readonly owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ + readonly repo: components["parameters"]["repo"]; + /** @description The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */ + readonly alert_number: components["parameters"]["alert-number"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["code-scanning-autofix"]; + }; + }; + readonly 400: components["responses"]["code_scanning_bad_request"]; + readonly 403: components["responses"]["code_scanning_forbidden_read"]; + readonly 404: components["responses"]["not_found"]; + readonly 503: components["responses"]["service_unavailable"]; + }; + }; + readonly "code-scanning/create-autofix": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The account owner of the repository. The name is not case sensitive. */ + readonly owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ + readonly repo: components["parameters"]["repo"]; + /** @description The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */ + readonly alert_number: components["parameters"]["alert-number"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description OK */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["code-scanning-autofix"]; + }; + }; + /** @description Accepted */ + readonly 202: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["code-scanning-autofix"]; + }; + }; + readonly 400: components["responses"]["code_scanning_bad_request"]; + readonly 403: components["responses"]["code_scanning_autofix_create_forbidden"]; + readonly 404: components["responses"]["not_found"]; + /** @description Unprocessable Entity */ + readonly 422: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + readonly 503: components["responses"]["service_unavailable"]; + }; + }; + readonly "code-scanning/commit-autofix": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The account owner of the repository. The name is not case sensitive. */ + readonly owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ + readonly repo: components["parameters"]["repo"]; + /** @description The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */ + readonly alert_number: components["parameters"]["alert-number"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: { + readonly content: { + readonly "application/json": components["schemas"]["code-scanning-autofix-commits"]; + }; + }; + readonly responses: { + /** @description Created */ + readonly 201: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["code-scanning-autofix-commits-response"]; + }; + }; + readonly 400: components["responses"]["code_scanning_bad_request"]; + readonly 403: components["responses"]["code_scanning_forbidden_write"]; + readonly 404: components["responses"]["not_found"]; + /** @description Unprocessable Entity */ + readonly 422: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + readonly 503: components["responses"]["service_unavailable"]; + }; + }; readonly "code-scanning/list-alert-instances": { readonly parameters: { readonly query?: { @@ -109679,6 +111055,163 @@ export interface operations { }; }; }; + readonly "issues/remove-sub-issue": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The account owner of the repository. The name is not case sensitive. */ + readonly owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ + readonly repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ + readonly issue_number: components["parameters"]["issue-number"]; + }; + readonly cookie?: never; + }; + readonly requestBody: { + readonly content: { + readonly "application/json": { + /** @description The sub-issue to remove */ + readonly sub_issue_id: number; + }; + }; + }; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + /** @example https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue */ + readonly Location?: string; + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["issue"]; + }; + }; + readonly 400: components["responses"]["bad_request"]; + readonly 404: components["responses"]["not_found"]; + }; + }; + readonly "issues/list-sub-issues": { + readonly parameters: { + readonly query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly page?: components["parameters"]["page"]; + }; + readonly header?: never; + readonly path: { + /** @description The account owner of the repository. The name is not case sensitive. */ + readonly owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ + readonly repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ + readonly issue_number: components["parameters"]["issue-number"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly Link: components["headers"]["link"]; + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": readonly components["schemas"]["issue"][]; + }; + }; + readonly 404: components["responses"]["not_found"]; + readonly 410: components["responses"]["gone"]; + }; + }; + readonly "issues/add-sub-issue": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The account owner of the repository. The name is not case sensitive. */ + readonly owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ + readonly repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ + readonly issue_number: components["parameters"]["issue-number"]; + }; + readonly cookie?: never; + }; + readonly requestBody: { + readonly content: { + readonly "application/json": { + /** @description The sub-issue to add */ + readonly sub_issue_id: number; + /** @description Option that, when true, instructs the operation to replace the sub-issues current parent issue */ + readonly replace_parent?: boolean; + }; + }; + }; + readonly responses: { + /** @description Response */ + readonly 201: { + headers: { + /** @example https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1 */ + readonly Location?: string; + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["issue"]; + }; + }; + readonly 403: components["responses"]["forbidden"]; + readonly 404: components["responses"]["not_found"]; + readonly 410: components["responses"]["gone"]; + readonly 422: components["responses"]["validation_failed"]; + }; + }; + readonly "issues/reprioritize-sub-issue": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The account owner of the repository. The name is not case sensitive. */ + readonly owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ + readonly repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ + readonly issue_number: components["parameters"]["issue-number"]; + }; + readonly cookie?: never; + }; + readonly requestBody: { + readonly content: { + readonly "application/json": { + /** @description The id of the sub-issue to reprioritize */ + readonly sub_issue_id: number; + /** @description The id of the sub-issue to be prioritized after (either positional argument after OR before should be specified). */ + readonly after_id?: number; + /** @description The id of the sub-issue to be prioritized before (either positional argument after OR before should be specified). */ + readonly before_id?: number; + }; + }; + }; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["issue"]; + }; + }; + readonly 403: components["responses"]["forbidden"]; + readonly 404: components["responses"]["not_found"]; + readonly 422: components["responses"]["validation_failed_simple"]; + readonly 503: components["responses"]["service_unavailable"]; + }; + }; readonly "issues/list-events-for-timeline": { readonly parameters: { readonly query?: { @@ -113291,9 +114824,7 @@ export interface operations { readonly query?: { /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ readonly state?: components["parameters"]["secret-scanning-alert-state"]; - /** @description A comma-separated list of secret types to return. By default all secret types are returned. - * See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" - * for a complete list of secret types. */ + /** @description A comma-separated list of secret types to return. All default secret patterns are returned. To return experimental patterns, pass the token name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. */ readonly secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ readonly resolution?: components["parameters"]["secret-scanning-alert-resolution"]; @@ -113534,6 +115065,39 @@ export interface operations { readonly 503: components["responses"]["service_unavailable"]; }; }; + readonly "secret-scanning/get-scan-history": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The account owner of the repository. The name is not case sensitive. */ + readonly owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ + readonly repo: components["parameters"]["repo"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["secret-scanning-scan-history"]; + }; + }; + /** @description Repository does not have GitHub Advanced Security or secret scanning enabled */ + readonly 404: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + readonly 503: components["responses"]["service_unavailable"]; + }; + }; readonly "security-advisories/list-repository-advisories": { readonly parameters: { readonly query?: { @@ -119189,6 +120753,7 @@ export interface operations { readonly attestations?: readonly { readonly bundle?: components["schemas"]["sigstore-bundle-0"]; readonly repository_id?: number; + readonly bundle_url?: string; }[]; }; }; diff --git a/packages/openapi-typescript/examples/github-api-next.ts b/packages/openapi-typescript/examples/github-api-next.ts index 353a548df..b652d4640 100644 --- a/packages/openapi-typescript/examples/github-api-next.ts +++ b/packages/openapi-typescript/examples/github-api-next.ts @@ -289,8 +289,6 @@ export interface paths { * * Optionally, use the `permissions` body parameter to specify the permissions that the installation access token should have. If `permissions` is not specified, the installation access token will have all of the permissions that were granted to the app. The installation access token cannot be granted permissions that the app was not granted. * - * When using the repository or permission parameters to reduce the access of the token, the complexity of the token is increased due to both the number of permissions in the request and the number of repositories the token will have access to. If the complexity is too large, the token will fail to be issued. If this occurs, the error message will indicate the maximum number of repositories that should be requested. For the average application requesting 8 permissions, this limit is around 5000 repositories. With fewer permissions requested, more repositories are supported. - * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ post: operations["apps/create-installation-access-token"]; @@ -602,7 +600,7 @@ export interface paths { patch?: never; trace?: never; }; - "/enterprises/{enterprise}/copilot/billing/seats": { + "/enterprises/{enterprise}/code-security/configurations": { parameters: { query?: never; header?: never; @@ -610,33 +608,31 @@ export interface paths { cookie?: never; }; /** - * List all Copilot seat assignments for an enterprise - * @description > [!NOTE] - * > This endpoint is in public preview and is subject to change. + * Get code security configurations for an enterprise + * @description Lists all code security configurations available in an enterprise. * - * Lists all Copilot seats currently being billed for across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription. + * The authenticated user must be an administrator of the enterprise in order to use this endpoint. * - * Users with access through multiple organizations or enterprise teams will only be counted toward `total_seats` once. - * - * For each organization or enterprise team which grants Copilot access to a user, a seat detail object will appear in the `seats` array. - * Each seat object contains information about the assigned user's most recent Copilot activity. Users must have - * telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. For more information about activity data, - * see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." + * OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. + */ + get: operations["code-security/get-configurations-for-enterprise"]; + put?: never; + /** + * Create a code security configuration for an enterprise + * @description Creates a code security configuration in an enterprise. * - * Only enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams. + * The authenticated user must be an administrator of the enterprise in order to use this endpoint. * - * Personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ - get: operations["copilot/list-copilot-seats-for-enterprise"]; - put?: never; - post?: never; + post: operations["code-security/create-configuration-for-enterprise"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/enterprises/{enterprise}/copilot/metrics": { + "/enterprises/{enterprise}/code-security/configurations/defaults": { parameters: { query?: never; header?: never; @@ -644,19 +640,14 @@ export interface paths { cookie?: never; }; /** - * Get Copilot metrics for an enterprise - * @description Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. - * - * The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, - * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, - * they must have telemetry enabled in their IDE. + * Get default code security configurations for an enterprise + * @description Lists the default code security configurations for an enterprise. * - * To access this endpoint, the Copilot Metrics API access policy must be enabled or set to "no policy" for the enterprise within GitHub settings. - * Only enterprise owners and billing managers can view Copilot metrics for the enterprise. + * The authenticated user must be an administrator of the enterprise in order to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. */ - get: operations["copilot/copilot-metrics-for-enterprise"]; + get: operations["code-security/get-default-configurations-for-enterprise"]; put?: never; post?: never; delete?: never; @@ -665,7 +656,7 @@ export interface paths { patch?: never; trace?: never; }; - "/enterprises/{enterprise}/copilot/usage": { + "/enterprises/{enterprise}/code-security/configurations/{configuration_id}": { parameters: { query?: never; header?: never; @@ -673,52 +664,85 @@ export interface paths { cookie?: never; }; /** - * Get a summary of Copilot usage for enterprise members - * @description > [!NOTE] - * > This endpoint is in public preview and is subject to change. + * Retrieve a code security configuration of an enterprise + * @description Gets a code security configuration available in an enterprise. * - * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE - * for all users across organizations with access to Copilot within your enterprise, with a further breakdown of suggestions, acceptances, - * and number of active users by editor and language for each day. See the response schema tab for detailed metrics definitions. + * The authenticated user must be an administrator of the enterprise in order to use this endpoint. * - * The response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day, - * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, - * they must have telemetry enabled in their IDE. + * OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. + */ + get: operations["code-security/get-single-configuration-for-enterprise"]; + put?: never; + post?: never; + /** + * Delete a code security configuration for an enterprise + * @description Deletes a code security configuration from an enterprise. + * Repositories attached to the configuration will retain their settings but will no longer be associated with + * the configuration. + * + * The authenticated user must be an administrator for the enterprise to use this endpoint. * - * The time zone in the response is in UTC time, that means that the cutoff time for the "day" is UTC time. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + */ + delete: operations["code-security/delete-configuration-for-enterprise"]; + options?: never; + head?: never; + /** + * Update a custom code security configuration for an enterprise + * @description Updates a code security configuration in an enterprise. * - * Only owners and billing managers can view Copilot usage metrics for the enterprise. + * The authenticated user must be an administrator of the enterprise in order to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ - get: operations["copilot/usage-metrics-for-enterprise"]; + patch: operations["code-security/update-enterprise-configuration"]; + trace?: never; + }; + "/enterprises/{enterprise}/code-security/configurations/{configuration_id}/attach": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; put?: never; - post?: never; + /** + * Attach an enterprise configuration to repositories + * @description Attaches an enterprise code security configuration to repositories. If the repositories specified are already attached to a configuration, they will be re-attached to the provided configuration. + * + * If insufficient GHAS licenses are available to attach the configuration to a repository, only free features will be enabled. + * + * The authenticated user must be an administrator for the enterprise to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + */ + post: operations["code-security/attach-enterprise-configuration"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/enterprises/{enterprise}/dependabot/alerts": { + "/enterprises/{enterprise}/code-security/configurations/{configuration_id}/defaults": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; + get?: never; /** - * List Dependabot alerts for an enterprise - * @description Lists Dependabot alerts for repositories that are owned by the specified enterprise. + * Set a code security configuration as a default for an enterprise + * @description Sets a code security configuration as a default to be applied to new repositories in your enterprise. * - * The authenticated user must be a member of the enterprise to use this endpoint. + * This configuration will be applied by default to the matching repository type when created, but only for organizations within the enterprise that do not already have a default code security configuration set. * - * Alerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager. For more information about security managers, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * The authenticated user must be an administrator for the enterprise to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ - get: operations["dependabot/list-alerts-for-enterprise"]; - put?: never; + put: operations["code-security/set-configuration-as-default-for-enterprise"]; post?: never; delete?: never; options?: never; @@ -726,7 +750,7 @@ export interface paths { patch?: never; trace?: never; }; - "/enterprises/{enterprise}/secret-scanning/alerts": { + "/enterprises/{enterprise}/code-security/configurations/{configuration_id}/repositories": { parameters: { query?: never; header?: never; @@ -734,16 +758,14 @@ export interface paths { cookie?: never; }; /** - * List secret scanning alerts for an enterprise - * @description Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest. - * - * Alerts are only returned for organizations in the enterprise for which the authenticated user is an organization owner or a [security manager](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization). + * Get repositories associated with an enterprise code security configuration + * @description Lists the repositories associated with an enterprise code security configuration in an organization. * - * The authenticated user must be a member of the enterprise in order to use this endpoint. + * The authenticated user must be an administrator of the enterprise in order to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope or `security_events` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. */ - get: operations["secret-scanning/list-alerts-for-enterprise"]; + get: operations["code-security/get-repositories-for-enterprise-configuration"]; put?: never; post?: never; delete?: never; @@ -752,7 +774,7 @@ export interface paths { patch?: never; trace?: never; }; - "/enterprises/{enterprise}/team/{team_slug}/copilot/metrics": { + "/enterprises/{enterprise}/dependabot/alerts": { parameters: { query?: never; header?: never; @@ -760,22 +782,16 @@ export interface paths { cookie?: never; }; /** - * Get Copilot metrics for an enterprise team - * @description Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. - * - * The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, - * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, - * they must have telemetry enabled in their IDE. + * List Dependabot alerts for an enterprise + * @description Lists Dependabot alerts for repositories that are owned by the specified enterprise. * - * > [!NOTE] - * > This endpoint will only return results for a given day if the enterprise team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day. + * The authenticated user must be a member of the enterprise to use this endpoint. * - * To access this endpoint, the Copilot Metrics API access policy must be enabled or set to "no policy" for the enterprise within GitHub settings. - * Only owners and billing managers for the enterprise that contains the enterprise team can view Copilot metrics for the enterprise team. + * Alerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager. For more information about security managers, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. */ - get: operations["copilot/copilot-metrics-for-enterprise-team"]; + get: operations["dependabot/list-alerts-for-enterprise"]; put?: never; post?: never; delete?: never; @@ -784,7 +800,7 @@ export interface paths { patch?: never; trace?: never; }; - "/enterprises/{enterprise}/team/{team_slug}/copilot/usage": { + "/enterprises/{enterprise}/secret-scanning/alerts": { parameters: { query?: never; header?: never; @@ -792,26 +808,16 @@ export interface paths { cookie?: never; }; /** - * Get a summary of Copilot usage for an enterprise team - * @description > [!NOTE] - * > This endpoint is in public preview and is subject to change. - * - * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE - * for users within an enterprise team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day. - * See the response schema tab for detailed metrics definitions. - * - * The response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day, - * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, - * they must have telemetry enabled in their IDE. + * List secret scanning alerts for an enterprise + * @description Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest. * - * > [!NOTE] - * > This endpoint will only return results for a given day if the enterprise team had five or more members with active Copilot licenses, as evaluated at the end of that day. + * Alerts are only returned for organizations in the enterprise for which the authenticated user is an organization owner or a [security manager](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization). * - * Owners and billing managers for the enterprise that contains the enterprise team can view Copilot usage metrics for the enterprise team. + * The authenticated user must be a member of the enterprise in order to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope or `security_events` scope to use this endpoint. */ - get: operations["copilot/usage-metrics-for-enterprise-team"]; + get: operations["secret-scanning/list-alerts-for-enterprise"]; put?: never; post?: never; delete?: never; @@ -1637,6 +1643,28 @@ export interface paths { patch?: never; trace?: never; }; + "/organizations/{org}/settings/billing/usage": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get billing usage report for an organization + * @description Gets a report of the total usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account. + * + * **Note:** This endpoint is only available to organizations with access to the enhanced billing platform. For more information, see "[About the enhanced billing platform](https://docs.github.com/billing/using-the-new-billing-platform)." + */ + get: operations["billing/get-github-billing-usage-report-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/orgs/{org}": { parameters: { query?: never; @@ -3217,13 +3245,11 @@ export interface paths { * Purchases a GitHub Copilot seat for all users within each specified team. * The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." * - * Only organization owners can add Copilot seats for their organization members. - * - * In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy. + * Only organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy. * For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." * For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." * - * The response will contain the total number of new seats that were created and existing seats that were refreshed. + * The response contains the total number of new seats that were created and existing seats that were refreshed. * * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. */ @@ -3235,14 +3261,11 @@ export interface paths { * * Sets seats for all members of each team specified to "pending cancellation". * This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team. - * - * For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." - * - * For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." + * For more information about disabling access to Copilot, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." * * Only organization owners can cancel Copilot seats for their organization members. * - * The response will contain the total number of seats set to "pending cancellation". + * The response contains the total number of seats set to "pending cancellation". * * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. */ @@ -3269,13 +3292,11 @@ export interface paths { * Purchases a GitHub Copilot seat for each user specified. * The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." * - * Only organization owners can add Copilot seats for their organization members. - * - * In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy. + * Only organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy. * For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." * For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." * - * The response will contain the total number of new seats that were created and existing seats that were refreshed. + * The response contains the total number of new seats that were created and existing seats that were refreshed. * * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. */ @@ -3287,14 +3308,11 @@ export interface paths { * * Sets seats for all users specified to "pending cancellation". * This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership. - * - * For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." - * - * For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." + * For more information about disabling access to Copilot, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." * * Only organization owners can cancel Copilot seats for their organization members. * - * The response will contain the total number of seats set to "pending cancellation". + * The response contains the total number of seats set to "pending cancellation". * * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. */ @@ -3609,7 +3627,9 @@ export interface paths { }; /** * List organization webhooks - * @description You must be an organization owner to use this endpoint. + * @description List webhooks for an organization. + * + * The authenticated user must be an organization owner to use this endpoint. * * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. @@ -3654,7 +3674,9 @@ export interface paths { post?: never; /** * Delete an organization webhook - * @description You must be an organization owner to use this endpoint. + * @description Delete a webhook for an organization. + * + * The authenticated user must be an organization owner to use this endpoint. * * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. @@ -5027,6 +5049,109 @@ export interface paths { patch?: never; trace?: never; }; + "/orgs/{org}/private-registries": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List private registries for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Lists all private registry configurations available at the organization-level without revealing their encrypted + * values. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + get: operations["private-registries/list-org-private-registries"]; + put?: never; + /** + * Create a private registry for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Creates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + post: operations["private-registries/create-org-private-registry"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/private-registries/public-key": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get private registries public key for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Gets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets. + * + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + get: operations["private-registries/get-org-public-key"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/private-registries/{secret_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get a private registry for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Get the configuration of a single private registry defined for an organization, omitting its encrypted value. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + get: operations["private-registries/get-org-private-registry"]; + put?: never; + post?: never; + /** + * Delete a private registry for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Delete a private registry configuration at the organization-level. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + delete: operations["private-registries/delete-org-private-registry"]; + options?: never; + head?: never; + /** + * Update a private registry for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + patch: operations["private-registries/update-org-private-registry"]; + trace?: never; + }; "/orgs/{org}/projects": { parameters: { query?: never; @@ -5384,11 +5509,9 @@ export interface paths { }; /** * List security manager teams - * @description Lists teams that are security managers for an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." - * - * The authenticated user must be an administrator or security manager for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the "[Organization Roles](https://docs.github.com/rest/orgs/organization-roles)" endpoints instead. */ get: operations["orgs/list-security-manager-teams"]; put?: never; @@ -5409,21 +5532,17 @@ export interface paths { get?: never; /** * Add a security manager team - * @description Adds a team as a security manager for an organization. For more information, see "[Managing security for an organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) for an organization." - * - * The authenticated user must be an administrator for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the "[Organization Roles](https://docs.github.com/rest/orgs/organization-roles)" endpoints instead. */ put: operations["orgs/add-security-manager-team"]; post?: never; /** * Remove a security manager team - * @description Removes the security manager role from a team for an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) team from an organization." - * - * The authenticated user must be an administrator for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the "[Organization Roles](https://docs.github.com/rest/orgs/organization-roles)" endpoints instead. */ delete: operations["orgs/remove-security-manager-team"]; options?: never; @@ -7166,7 +7285,7 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. * - * This API will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`. + * This endpoint will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`. */ get: operations["actions/list-workflow-runs-for-repo"]; put?: never; @@ -7871,6 +7990,8 @@ export interface paths { * Anyone with read access to the repository can use this endpoint * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * + * This endpoint will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`. */ get: operations["actions/list-workflow-runs"]; put?: never; @@ -8806,6 +8927,62 @@ export interface paths { patch: operations["code-scanning/update-alert"]; trace?: never; }; + "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/autofix": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get the status of an autofix for a code scanning alert + * @description Gets the status and description of an autofix for a code scanning alert. + * + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + */ + get: operations["code-scanning/get-autofix"]; + put?: never; + /** + * Create an autofix for a code scanning alert + * @description Creates an autofix for a code scanning alert. + * + * If a new autofix is to be created as a result of this request or is currently being generated, then this endpoint will return a 202 Accepted response. + * + * If an autofix already exists for a given alert, then this endpoint will return a 200 OK response. + * + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + */ + post: operations["code-scanning/create-autofix"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/autofix/commits": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Commit an autofix for a code scanning alert + * @description Commits an autofix for a code scanning alert. + * + * If an autofix is commited as a result of this request, then this endpoint will return a 201 Created response. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + */ + post: operations["code-scanning/commit-autofix"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances": { parameters: { query?: never; @@ -9700,6 +9877,7 @@ export interface paths { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -9842,6 +10020,7 @@ export interface paths { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -10042,6 +10221,7 @@ export interface paths { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -11026,6 +11206,7 @@ export interface paths { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -11075,6 +11256,7 @@ export interface paths { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -11220,6 +11402,7 @@ export interface paths { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -11265,6 +11448,7 @@ export interface paths { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -11381,7 +11565,12 @@ export interface paths { get: operations["repos/get-webhook"]; put?: never; post?: never; - /** Delete a repository webhook */ + /** + * Delete a repository webhook + * @description Delete a webhook for an organization. + * + * The authenticated user must be a repository owner, or have admin access in the repository, to delete the webhook. + */ delete: operations["repos/delete-webhook"]; options?: never; head?: never; @@ -12288,6 +12477,96 @@ export interface paths { patch?: never; trace?: never; }; + "/repos/{owner}/{repo}/issues/{issue_number}/sub_issue": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + /** + * Remove sub-issue + * @description You can use the REST API to remove a sub-issue from an issue. + * Removing content too quickly using this endpoint may result in secondary rate limiting. + * For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass a specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + */ + delete: operations["issues/remove-sub-issue"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/issues/{issue_number}/sub_issues": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List sub-issues + * @description You can use the REST API to list the sub-issues on an issue. + * + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + */ + get: operations["issues/list-sub-issues"]; + put?: never; + /** + * Add sub-issue + * @description You can use the REST API to add sub-issues to issues. + * + * Creating content too quickly using this endpoint may result in secondary rate limiting. + * For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + * + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + */ + post: operations["issues/add-sub-issue"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/issues/{issue_number}/sub_issues/priority": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + /** + * Reprioritize sub-issue + * @description You can use the REST API to reprioritize a sub-issue to a different position in the parent list. + */ + patch: operations["issues/reprioritize-sub-issue"]; + trace?: never; + }; "/repos/{owner}/{repo}/issues/{issue_number}/timeline": { parameters: { query?: never; @@ -13586,7 +13865,13 @@ export interface paths { }; /** * Get a release asset - * @description To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response. + * @description To download the asset's binary content: + * + * - If within a browser, fetch the location specified in the `browser_download_url` key provided in the response. + * - Alternatively, set the `Accept` header of the request to + * [`application/octet-stream`](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + * The API will either redirect the client to the location, or stream it directly if possible. + * API clients should handle both a `200` or `302` response. */ get: operations["repos/get-release-asset"]; put?: never; @@ -14005,6 +14290,28 @@ export interface paths { patch?: never; trace?: never; }; + "/repos/{owner}/{repo}/secret-scanning/scan-history": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get secret scanning scan history for a repository + * @description Lists the latest incremental and backfill scans by type for a repository. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + */ + get: operations["secret-scanning/get-scan-history"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/repos/{owner}/{repo}/security-advisories": { parameters: { query?: never; @@ -23131,6 +23438,31 @@ export interface webhooks { patch?: never; trace?: never; }; + "secret-scanning-scan-completed": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * This event occurs when secret scanning completes certain scans on a repository. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." + * + * Scans can originate from multiple events such as updates to a custom pattern, a push to a repository, or updates + * to patterns from partners. For more information on custom patterns, see "[About custom patterns](https://docs.github.com/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns)." + * + * To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + * @description A secret scanning scan was completed. + */ + post: operations["secret-scanning-scan/completed"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "security-advisory-published": { parameters: { query?: never; @@ -25189,464 +25521,146 @@ export interface components { /** Format: uri */ html_url: string | null; }; - /** - * Organization Simple - * @description A GitHub organization. - */ - "organization-simple": { - login: string; - id: number; - node_id: string; - /** Format: uri */ - url: string; - /** Format: uri */ - repos_url: string; - /** Format: uri */ - events_url: string; - hooks_url: string; - issues_url: string; - members_url: string; - public_members_url: string; - avatar_url: string; - description: string | null; - }; - /** - * Team Simple - * @description Groups of organization members that gives permissions on specified repositories. - */ - "team-simple": { - /** @description Unique identifier of the team */ - id: number; - node_id: string; + /** @description A code security configuration */ + "code-security-configuration": { + /** @description The ID of the code security configuration */ + id?: number; + /** @description The name of the code security configuration. Must be unique within the organization. */ + name?: string; /** - * Format: uri - * @description URL for the team + * @description The type of the code security configuration. + * @enum {string} */ - url: string; - members_url: string; - /** @description Name of the team */ - name: string; - /** @description Description of the team */ - description: string | null; - /** @description Permission that the team will have for its repositories */ - permission: string; - /** @description The level of privacy this team should have */ - privacy?: string; - /** @description The notification setting the team has set */ - notification_setting?: string; - /** Format: uri */ - html_url: string; - /** Format: uri */ - repositories_url: string; - slug: string; - /** @description Distinguished Name (DN) that team maps to within LDAP environment */ - ldap_dn?: string; - }; - /** - * Team - * @description Groups of organization members that gives permissions on specified repositories. - */ - team: { - id: number; - node_id: string; - name: string; - slug: string; - description: string | null; - privacy?: string; - notification_setting?: string; - permission: string; - permissions?: { - pull: boolean; - triage: boolean; - push: boolean; - maintain: boolean; - admin: boolean; - }; - /** Format: uri */ - url: string; - /** Format: uri */ - html_url: string; - members_url: string; - /** Format: uri */ - repositories_url: string; - parent: null | components["schemas"]["team-simple"]; - }; - /** - * Enterprise Team - * @description Group of enterprise owners and/or members - */ - "enterprise-team": { - /** Format: int64 */ - id: number; - name: string; - slug: string; - /** Format: uri */ - url: string; - sync_to_organizations: string; - group_id?: string | null; - /** Format: uri */ - html_url: string; - members_url: string; - /** Format: date-time */ - created_at: string; - /** Format: date-time */ - updated_at: string; - }; - /** - * Copilot Business Seat Detail - * @description Information about a Copilot Business seat assignment for a user, team, or organization. - */ - "copilot-seat-details": { - assignee: components["schemas"]["simple-user"]; - organization?: null | components["schemas"]["organization-simple"]; - /** @description The team through which the assignee is granted access to GitHub Copilot, if applicable. */ - assigning_team?: (null | Record) & (components["schemas"]["team"] | components["schemas"]["enterprise-team"]); + target_type?: "global" | "organization" | "enterprise"; + /** @description A description of the code security configuration */ + description?: string; /** - * Format: date - * @description The pending cancellation date for the seat, in `YYYY-MM-DD` format. This will be null unless the assignee's Copilot access has been canceled during the current billing cycle. If the seat has been cancelled, this corresponds to the start of the organization's next billing cycle. + * @description The enablement status of GitHub Advanced Security + * @enum {string} */ - pending_cancellation_date?: string | null; + advanced_security?: "enabled" | "disabled"; /** - * Format: date-time - * @description Timestamp of user's last GitHub Copilot activity, in ISO 8601 format. + * @description The enablement status of Dependency Graph + * @enum {string} */ - last_activity_at?: string | null; - /** @description Last editor that was used by the user for a GitHub Copilot completion. */ - last_activity_editor?: string | null; + dependency_graph?: "enabled" | "disabled" | "not_set"; /** - * Format: date-time - * @description Timestamp of when the assignee was last granted access to GitHub Copilot, in ISO 8601 format. + * @description The enablement status of Automatic dependency submission + * @enum {string} */ - created_at: string; + dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for Automatic dependency submission */ + dependency_graph_autosubmit_action_options?: { + /** @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. */ + labeled_runners?: boolean; + }; /** - * Format: date-time - * @description Timestamp of when the assignee's GitHub Copilot access was last updated, in ISO 8601 format. + * @description The enablement status of Dependabot alerts + * @enum {string} */ - updated_at?: string; + dependabot_alerts?: "enabled" | "disabled" | "not_set"; /** - * @description The Copilot plan of the organization, or the parent enterprise, when applicable. + * @description The enablement status of Dependabot security updates * @enum {string} */ - plan_type?: "business" | "enterprise" | "unknown"; - }; - /** @description Usage metrics for Copilot editor code completions in the IDE. */ - "copilot-ide-code-completions": ({ - /** @description Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances. */ - total_engaged_users?: number; - /** @description Code completion metrics for active languages. */ - languages?: { - /** @description Name of the language used for Copilot code completion suggestions. */ - name?: string; - /** @description Number of users who accepted at least one Copilot code completion suggestion for the given language. Includes both full and partial acceptances. */ - total_engaged_users?: number; - }[]; - editors?: ({ - /** @description Name of the given editor. */ - name?: string; - /** @description Number of users who accepted at least one Copilot code completion suggestion for the given editor. Includes both full and partial acceptances. */ - total_engaged_users?: number; - /** @description List of model metrics for custom models and the default model. */ - models?: { - /** @description Name of the language used for Copilot code completion suggestions, for the given editor. */ - name?: string; - /** @description Indicates whether a model is custom or default. */ - is_custom_model?: boolean; - /** @description The training date for the custom model. */ - custom_model_training_date?: string | null; - /** @description Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances. */ - total_engaged_users?: number; - /** @description Code completion metrics for active languages, for the given editor. */ - languages?: { - /** @description Name of the language used for Copilot code completion suggestions, for the given editor. */ - name?: string; - /** @description Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language. Includes both full and partial acceptances. */ - total_engaged_users?: number; - /** @description The number of Copilot code suggestions generated for the given editor, for the given language. */ - total_code_suggestions?: number; - /** @description The number of Copilot code suggestions accepted for the given editor, for the given language. Includes both full and partial acceptances. */ - total_code_acceptances?: number; - /** @description The number of lines of code suggested by Copilot code completions for the given editor, for the given language. */ - total_code_lines_suggested?: number; - /** @description The number of lines of code accepted from Copilot code suggestions for the given editor, for the given language. */ - total_code_lines_accepted?: number; - }[]; - }[]; - } & { - [key: string]: unknown; - })[]; - } & { - [key: string]: unknown; - }) | null; - /** @description Usage metrics for Copilot Chat in the IDE. */ - "copilot-ide-chat": ({ - /** @description Total number of users who prompted Copilot Chat in the IDE. */ - total_engaged_users?: number; - editors?: { - /** @description Name of the given editor. */ - name?: string; - /** @description The number of users who prompted Copilot Chat in the specified editor. */ - total_engaged_users?: number; - /** @description List of model metrics for custom models and the default model. */ - models?: { - /** @description Name of the language used for Copilot code completion suggestions, for the given editor. */ - name?: string; - /** @description Indicates whether a model is custom or default. */ - is_custom_model?: boolean; - /** @description The training date for the custom model. */ - custom_model_training_date?: string | null; - /** @description The number of users who prompted Copilot Chat in the given editor and model. */ - total_engaged_users?: number; - /** @description The total number of chats initiated by users in the given editor and model. */ - total_chats?: number; - /** @description The number of times users accepted a code suggestion from Copilot Chat using the 'Insert Code' UI element, for the given editor. */ - total_chat_insertion_events?: number; - /** @description The number of times users copied a code suggestion from Copilot Chat using the keyboard, or the 'Copy' UI element, for the given editor. */ - total_chat_copy_events?: number; - }[]; - }[]; - } & { - [key: string]: unknown; - }) | null; - /** @description Usage metrics for Copilot Chat in github.com */ - "copilot-dotcom-chat": ({ - /** @description Total number of users who prompted Copilot Chat on github.com at least once. */ - total_engaged_users?: number; - /** @description List of model metrics for a custom models and the default model. */ - models?: { - /** @description Name of the language used for Copilot code completion suggestions, for the given editor. */ - name?: string; - /** @description Indicates whether a model is custom or default. */ - is_custom_model?: boolean; - /** @description The training date for the custom model (if applicable). */ - custom_model_training_date?: string | null; - /** @description Total number of users who prompted Copilot Chat on github.com at least once for each model. */ - total_engaged_users?: number; - /** @description Total number of chats initiated by users on github.com. */ - total_chats?: number; - }[]; - } & { - [key: string]: unknown; - }) | null; - /** @description Usage metrics for Copilot for pull requests. */ - "copilot-dotcom-pull-requests": ({ - /** @description The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once. */ - total_engaged_users?: number; - /** @description Repositories in which users used Copilot for Pull Requests to generate pull request summaries */ - repositories?: { - /** @description Repository name */ - name?: string; - /** @description The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository. */ - total_engaged_users?: number; - /** @description List of model metrics for custom models and the default model. */ - models?: { - /** @description Name of the language used for Copilot code completion suggestions, for the given editor. */ - name?: string; - /** @description Indicates whether a model is custom or default. */ - is_custom_model?: boolean; - /** @description The training date for the custom model. */ - custom_model_training_date?: string | null; - /** @description The number of pull request summaries generated using Copilot for Pull Requests in the given repository. */ - total_pr_summaries_created?: number; - /** @description The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository and model. */ - total_engaged_users?: number; - }[]; - }[]; - } & { - [key: string]: unknown; - }) | null; - /** - * Copilot Usage Metrics - * @description Copilot usage metrics for a given day. - */ - "copilot-usage-metrics-day": { + dependabot_security_updates?: "enabled" | "disabled" | "not_set"; /** - * Format: date - * @description The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format. + * @description The enablement status of code scanning default setup + * @enum {string} */ - date: string; - /** @description The total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint. */ - total_active_users?: number; - /** @description The total number of Copilot users who engaged with any Copilot feature, for the given day. Examples include but are not limited to accepting a code suggestion, prompting Copilot chat, or triggering a PR Summary. Does not include authentication events. Is not limited to the individual features detailed on the endpoint. */ - total_engaged_users?: number; - copilot_ide_code_completions?: components["schemas"]["copilot-ide-code-completions"]; - copilot_ide_chat?: components["schemas"]["copilot-ide-chat"]; - copilot_dotcom_chat?: components["schemas"]["copilot-dotcom-chat"]; - copilot_dotcom_pull_requests?: components["schemas"]["copilot-dotcom-pull-requests"]; - } & { - [key: string]: unknown; - }; - /** - * Copilot Usage Metrics - * @description Summary of Copilot usage. - */ - "copilot-usage-metrics": { + code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for code scanning default setup */ + code_scanning_default_setup_options?: { + /** + * @description Whether to use labeled runners or standard GitHub runners. + * @enum {string|null} + */ + runner_type?: "standard" | "labeled" | "not_set" | null; + /** @description The label of the runner to use for code scanning when runner_type is 'labeled'. */ + runner_label?: string | null; + } | null; /** - * Format: date - * @description The date for which the usage metrics are reported, in `YYYY-MM-DD` format. + * @description The enablement status of secret scanning + * @enum {string} */ - day: string; - /** @description The total number of Copilot code completion suggestions shown to users. */ - total_suggestions_count?: number; - /** @description The total number of Copilot code completion suggestions accepted by users. */ - total_acceptances_count?: number; - /** @description The total number of lines of code completions suggested by Copilot. */ - total_lines_suggested?: number; - /** @description The total number of lines of code completions accepted by users. */ - total_lines_accepted?: number; - /** @description The total number of users who were shown Copilot code completion suggestions during the day specified. */ - total_active_users?: number; - /** @description The total instances of users who accepted code suggested by Copilot Chat in the IDE (panel and inline). */ - total_chat_acceptances?: number; - /** @description The total number of chat turns (prompt and response pairs) sent between users and Copilot Chat in the IDE. */ - total_chat_turns?: number; - /** @description The total number of users who interacted with Copilot Chat in the IDE during the day specified. */ - total_active_chat_users?: number; - /** @description Breakdown of Copilot code completions usage by language and editor */ - breakdown: ({ - /** @description The language in which Copilot suggestions were shown to users in the specified editor. */ - language?: string; - /** @description The editor in which Copilot suggestions were shown to users for the specified language. */ - editor?: string; - /** @description The number of Copilot suggestions shown to users in the editor specified during the day specified. */ - suggestions_count?: number; - /** @description The number of Copilot suggestions accepted by users in the editor specified during the day specified. */ - acceptances_count?: number; - /** @description The number of lines of code suggested by Copilot in the editor specified during the day specified. */ - lines_suggested?: number; - /** @description The number of lines of code accepted by users in the editor specified during the day specified. */ - lines_accepted?: number; - /** @description The number of users who were shown Copilot completion suggestions in the editor specified during the day specified. */ - active_users?: number; - } & { - [key: string]: unknown; - })[] | null; - }; - /** @description The security alert number. */ - "alert-number": number; - /** @description Details for the vulnerable package. */ - "dependabot-alert-package": { - /** @description The package's language or package management ecosystem. */ - readonly ecosystem: string; - /** @description The unique package name within its ecosystem. */ - readonly name: string; - }; - /** @description Details pertaining to one vulnerable version range for the advisory. */ - "dependabot-alert-security-vulnerability": { - package: components["schemas"]["dependabot-alert-package"]; + secret_scanning?: "enabled" | "disabled" | "not_set"; /** - * @description The severity of the vulnerability. + * @description The enablement status of secret scanning push protection * @enum {string} */ - readonly severity: "low" | "medium" | "high" | "critical"; - /** @description Conditions that identify vulnerable versions of this vulnerability's package. */ - readonly vulnerable_version_range: string; - /** @description Details pertaining to the package version that patches this vulnerability. */ - readonly first_patched_version: { - /** @description The package version that patches this vulnerability. */ - readonly identifier: string; - } | null; - }; - /** @description Details for the GitHub Security Advisory. */ - "dependabot-alert-security-advisory": { - /** @description The unique GitHub Security Advisory ID assigned to the advisory. */ - readonly ghsa_id: string; - /** @description The unique CVE ID assigned to the advisory. */ - readonly cve_id: string | null; - /** @description A short, plain text summary of the advisory. */ - readonly summary: string; - /** @description A long-form Markdown-supported description of the advisory. */ - readonly description: string; - /** @description Vulnerable version range information for the advisory. */ - readonly vulnerabilities: components["schemas"]["dependabot-alert-security-vulnerability"][]; + secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; /** - * @description The severity of the advisory. + * @description The enablement status of secret scanning delegated bypass * @enum {string} */ - readonly severity: "low" | "medium" | "high" | "critical"; - /** @description Details for the advisory pertaining to the Common Vulnerability Scoring System. */ - readonly cvss: { - /** @description The overall CVSS score of the advisory. */ - readonly score: number; - /** @description The full CVSS vector string for the advisory. */ - readonly vector_string: string | null; + secret_scanning_delegated_bypass?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for secret scanning delegated bypass */ + secret_scanning_delegated_bypass_options?: { + /** @description The bypass reviewers for secret scanning delegated bypass */ + reviewers?: { + /** @description The ID of the team or role selected as a bypass reviewer */ + reviewer_id: number; + /** + * @description The type of the bypass reviewer + * @enum {string} + */ + reviewer_type: "TEAM" | "ROLE"; + }[]; }; - cvss_severities?: components["schemas"]["cvss-severities"]; - /** @description Details for the advisory pertaining to Common Weakness Enumeration. */ - readonly cwes: { - /** @description The unique CWE ID. */ - readonly cwe_id: string; - /** @description The short, plain text name of the CWE. */ - readonly name: string; - }[]; - /** @description Values that identify this advisory among security information sources. */ - readonly identifiers: { - /** - * @description The type of advisory identifier. - * @enum {string} - */ - readonly type: "CVE" | "GHSA"; - /** @description The value of the advisory identifer. */ - readonly value: string; - }[]; - /** @description Links to additional advisory information. */ - readonly references: { - /** - * Format: uri - * @description The URL of the reference. - */ - readonly url: string; - }[]; /** - * Format: date-time - * @description The time that the advisory was published in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @description The enablement status of secret scanning validity checks + * @enum {string} */ - readonly published_at: string; + secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; /** - * Format: date-time - * @description The time that the advisory was last modified in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @description The enablement status of secret scanning non-provider patterns + * @enum {string} */ - readonly updated_at: string; + secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set"; /** - * Format: date-time - * @description The time that the advisory was withdrawn in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @description The enablement status of private vulnerability reporting + * @enum {string} */ - readonly withdrawn_at: string | null; + private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; + /** + * @description The enforcement status for a security configuration + * @enum {string} + */ + enforcement?: "enforced" | "unenforced"; + /** + * Format: uri + * @description The URL of the configuration + */ + url?: string; + /** + * Format: uri + * @description The URL of the configuration + */ + html_url?: string; + /** Format: date-time */ + created_at?: string; + /** Format: date-time */ + updated_at?: string; }; - /** - * Format: uri - * @description The REST API URL of the alert resource. - */ - "alert-url": string; - /** - * Format: uri - * @description The GitHub URL of the alert resource. - */ - "alert-html-url": string; - /** - * Format: date-time - * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. - */ - "alert-created-at": string; - /** - * Format: date-time - * @description The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. - */ - "alert-updated-at": string; - /** - * Format: date-time - * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. - */ - "alert-dismissed-at": string | null; - /** - * Format: date-time - * @description The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. - */ - "alert-fixed-at": string | null; - /** - * Format: date-time - * @description The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. - */ - "alert-auto-dismissed-at": string | null; + /** @description Feature options for code scanning default setup */ + "code-scanning-default-setup-options": { + /** + * @description Whether to use labeled runners or standard GitHub runners. + * @enum {string} + */ + runner_type?: "standard" | "labeled" | "not_set"; + /** @description The label of the runner to use for code scanning default setup when runner_type is 'labeled'. */ + runner_label?: string | null; + } | null; + /** @description A list of default code security configurations */ + "code-security-default-configurations": { + /** + * @description The visibility of newly created repositories for which the code security configuration will be applied to by default + * @enum {unknown} + */ + default_for_new_repos?: "public" | "private_and_internal" | "all"; + configuration?: components["schemas"]["code-security-configuration"]; + }[]; /** * Simple Repository * @description A GitHub repository. @@ -25792,6 +25806,141 @@ export interface components { */ hooks_url: string; }; + /** @description Repositories associated with a code security configuration and attachment status */ + "code-security-configuration-repositories": { + /** + * @description The attachment status of the code security configuration on the repository. + * @enum {string} + */ + status?: "attached" | "attaching" | "detached" | "removed" | "enforced" | "failed" | "updating" | "removed_by_enterprise"; + repository?: components["schemas"]["simple-repository"]; + }; + /** @description The security alert number. */ + "alert-number": number; + /** @description Details for the vulnerable package. */ + "dependabot-alert-package": { + /** @description The package's language or package management ecosystem. */ + readonly ecosystem: string; + /** @description The unique package name within its ecosystem. */ + readonly name: string; + }; + /** @description Details pertaining to one vulnerable version range for the advisory. */ + "dependabot-alert-security-vulnerability": { + package: components["schemas"]["dependabot-alert-package"]; + /** + * @description The severity of the vulnerability. + * @enum {string} + */ + readonly severity: "low" | "medium" | "high" | "critical"; + /** @description Conditions that identify vulnerable versions of this vulnerability's package. */ + readonly vulnerable_version_range: string; + /** @description Details pertaining to the package version that patches this vulnerability. */ + readonly first_patched_version: { + /** @description The package version that patches this vulnerability. */ + readonly identifier: string; + } | null; + }; + /** @description Details for the GitHub Security Advisory. */ + "dependabot-alert-security-advisory": { + /** @description The unique GitHub Security Advisory ID assigned to the advisory. */ + readonly ghsa_id: string; + /** @description The unique CVE ID assigned to the advisory. */ + readonly cve_id: string | null; + /** @description A short, plain text summary of the advisory. */ + readonly summary: string; + /** @description A long-form Markdown-supported description of the advisory. */ + readonly description: string; + /** @description Vulnerable version range information for the advisory. */ + readonly vulnerabilities: components["schemas"]["dependabot-alert-security-vulnerability"][]; + /** + * @description The severity of the advisory. + * @enum {string} + */ + readonly severity: "low" | "medium" | "high" | "critical"; + /** @description Details for the advisory pertaining to the Common Vulnerability Scoring System. */ + readonly cvss: { + /** @description The overall CVSS score of the advisory. */ + readonly score: number; + /** @description The full CVSS vector string for the advisory. */ + readonly vector_string: string | null; + }; + cvss_severities?: components["schemas"]["cvss-severities"]; + /** @description Details for the advisory pertaining to Common Weakness Enumeration. */ + readonly cwes: { + /** @description The unique CWE ID. */ + readonly cwe_id: string; + /** @description The short, plain text name of the CWE. */ + readonly name: string; + }[]; + /** @description Values that identify this advisory among security information sources. */ + readonly identifiers: { + /** + * @description The type of advisory identifier. + * @enum {string} + */ + readonly type: "CVE" | "GHSA"; + /** @description The value of the advisory identifer. */ + readonly value: string; + }[]; + /** @description Links to additional advisory information. */ + readonly references: { + /** + * Format: uri + * @description The URL of the reference. + */ + readonly url: string; + }[]; + /** + * Format: date-time + * @description The time that the advisory was published in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + readonly published_at: string; + /** + * Format: date-time + * @description The time that the advisory was last modified in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + readonly updated_at: string; + /** + * Format: date-time + * @description The time that the advisory was withdrawn in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + readonly withdrawn_at: string | null; + }; + /** + * Format: uri + * @description The REST API URL of the alert resource. + */ + "alert-url": string; + /** + * Format: uri + * @description The GitHub URL of the alert resource. + */ + "alert-html-url": string; + /** + * Format: date-time + * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + "alert-created-at": string; + /** + * Format: date-time + * @description The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + "alert-updated-at": string; + /** + * Format: date-time + * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + "alert-dismissed-at": string | null; + /** + * Format: date-time + * @description The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + "alert-fixed-at": string | null; + /** + * Format: date-time + * @description The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + "alert-auto-dismissed-at": string | null; /** @description A Dependabot alert. */ "dependabot-alert-with-repository": { number: components["schemas"]["alert-number"]; @@ -25875,6 +26024,16 @@ export interface components { * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ push_protection_bypassed_at?: string | null; + push_protection_bypass_request_reviewer?: null | components["schemas"]["simple-user"]; + /** @description An optional comment when reviewing a push protection bypass. */ + push_protection_bypass_request_reviewer_comment?: string | null; + /** @description An optional comment when requesting a push protection bypass. */ + push_protection_bypass_request_comment?: string | null; + /** + * Format: uri + * @description The URL to a push protection bypass request. + */ + push_protection_bypass_request_html_url?: string | null; /** @description The comment that was optionally added when this alert was closed */ resolution_comment?: string | null; /** @@ -25957,6 +26116,12 @@ export interface components { eyes: number; rocket: number; }; + /** Sub-issues Summary */ + "sub-issues-summary": { + total: number; + completed: number; + percent_completed: number; + }; /** * Issue * @description Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. @@ -26039,6 +26204,7 @@ export interface components { performed_via_github_app?: null | components["schemas"]["integration"]; author_association: components["schemas"]["author-association"]; reactions?: components["schemas"]["reaction-rollup"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; }; /** * Issue Comment @@ -26518,6 +26684,10 @@ export interface components { copilot?: string[]; packages?: string[]; actions?: string[]; + actions_inbound?: { + full_domains?: string[]; + wildcard_domains?: string[]; + }; artifact_attestations?: { trust_domain?: string; services?: string[]; @@ -26716,6 +26886,53 @@ export interface components { /** Format: uri */ repository_url?: string; }; + /** + * Organization Simple + * @description A GitHub organization. + */ + "organization-simple": { + login: string; + id: number; + node_id: string; + /** Format: uri */ + url: string; + /** Format: uri */ + repos_url: string; + /** Format: uri */ + events_url: string; + hooks_url: string; + issues_url: string; + members_url: string; + public_members_url: string; + avatar_url: string; + description: string | null; + }; + "billing-usage-report": { + usageItems?: { + /** @description Date of the usage line item. */ + date: string; + /** @description Product name. */ + product: string; + /** @description SKU name. */ + sku: string; + /** @description Quantity of the usage line item. */ + quantity: number; + /** @description Unit type of the usage line item. */ + unitType: string; + /** @description Price per unit of the usage line item. */ + pricePerUnit: number; + /** @description Gross amount of the usage line item. */ + grossAmount: number; + /** @description Discount amount of the usage line item. */ + discountAmount: number; + /** @description Net amount of the usage line item. */ + netAmount: number; + /** @description Name of the organization. */ + organizationName: string; + /** @description Name of the repository. */ + repositoryName?: string; + }[]; + }; /** * Organization Full * @description Organization Full @@ -27199,135 +27416,6 @@ export interface components { most_recent_instance: components["schemas"]["code-scanning-alert-instance"]; repository: components["schemas"]["simple-repository"]; }; - /** @description A code security configuration */ - "code-security-configuration": { - /** @description The ID of the code security configuration */ - id?: number; - /** @description The name of the code security configuration. Must be unique within the organization. */ - name?: string; - /** - * @description The type of the code security configuration. - * @enum {string} - */ - target_type?: "global" | "organization" | "enterprise"; - /** @description A description of the code security configuration */ - description?: string; - /** - * @description The enablement status of GitHub Advanced Security - * @enum {string} - */ - advanced_security?: "enabled" | "disabled"; - /** - * @description The enablement status of Dependency Graph - * @enum {string} - */ - dependency_graph?: "enabled" | "disabled" | "not_set"; - /** - * @description The enablement status of Automatic dependency submission - * @enum {string} - */ - dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"; - /** @description Feature options for Automatic dependency submission */ - dependency_graph_autosubmit_action_options?: { - /** @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. */ - labeled_runners?: boolean; - }; - /** - * @description The enablement status of Dependabot alerts - * @enum {string} - */ - dependabot_alerts?: "enabled" | "disabled" | "not_set"; - /** - * @description The enablement status of Dependabot security updates - * @enum {string} - */ - dependabot_security_updates?: "enabled" | "disabled" | "not_set"; - /** - * @description The enablement status of code scanning default setup - * @enum {string} - */ - code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; - /** - * @description The enablement status of secret scanning - * @enum {string} - */ - secret_scanning?: "enabled" | "disabled" | "not_set"; - /** - * @description The enablement status of secret scanning push protection - * @enum {string} - */ - secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; - /** - * @description The enablement status of secret scanning delegated bypass - * @enum {string} - */ - secret_scanning_delegated_bypass?: "enabled" | "disabled" | "not_set"; - /** @description Feature options for secret scanning delegated bypass */ - secret_scanning_delegated_bypass_options?: { - /** @description The bypass reviewers for secret scanning delegated bypass */ - reviewers?: { - /** @description The ID of the team or role selected as a bypass reviewer */ - reviewer_id: number; - /** - * @description The type of the bypass reviewer - * @enum {string} - */ - reviewer_type: "TEAM" | "ROLE"; - }[]; - }; - /** - * @description The enablement status of secret scanning validity checks - * @enum {string} - */ - secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; - /** - * @description The enablement status of secret scanning non-provider patterns - * @enum {string} - */ - secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set"; - /** - * @description The enablement status of private vulnerability reporting - * @enum {string} - */ - private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; - /** - * @description The enforcement status for a security configuration - * @enum {string} - */ - enforcement?: "enforced" | "unenforced"; - /** - * Format: uri - * @description The URL of the configuration - */ - url?: string; - /** - * Format: uri - * @description The URL of the configuration - */ - html_url?: string; - /** Format: date-time */ - created_at?: string; - /** Format: date-time */ - updated_at?: string; - }; - /** @description A list of default code security configurations */ - "code-security-default-configurations": { - /** - * @description The visibility of newly created repositories for which the code security configuration will be applied to by default - * @enum {unknown} - */ - default_for_new_repos?: "public" | "private_and_internal" | "all"; - configuration?: components["schemas"]["code-security-configuration"]; - }[]; - /** @description Repositories associated with a code security configuration and attachment status */ - "code-security-configuration-repositories": { - /** - * @description The attachment status of the code security configuration on the repository. - * @enum {string} - */ - status?: "attached" | "attaching" | "detached" | "removed" | "enforced" | "failed" | "updating" | "removed_by_enterprise"; - repository?: components["schemas"]["simple-repository"]; - }; /** * Codespace machine * @description A description of the machine powering a codespace. @@ -27561,6 +27649,318 @@ export interface components { } & { [key: string]: unknown; }; + /** + * Team Simple + * @description Groups of organization members that gives permissions on specified repositories. + */ + "team-simple": { + /** @description Unique identifier of the team */ + id: number; + node_id: string; + /** + * Format: uri + * @description URL for the team + */ + url: string; + members_url: string; + /** @description Name of the team */ + name: string; + /** @description Description of the team */ + description: string | null; + /** @description Permission that the team will have for its repositories */ + permission: string; + /** @description The level of privacy this team should have */ + privacy?: string; + /** @description The notification setting the team has set */ + notification_setting?: string; + /** Format: uri */ + html_url: string; + /** Format: uri */ + repositories_url: string; + slug: string; + /** @description Distinguished Name (DN) that team maps to within LDAP environment */ + ldap_dn?: string; + }; + /** + * Team + * @description Groups of organization members that gives permissions on specified repositories. + */ + team: { + id: number; + node_id: string; + name: string; + slug: string; + description: string | null; + privacy?: string; + notification_setting?: string; + permission: string; + permissions?: { + pull: boolean; + triage: boolean; + push: boolean; + maintain: boolean; + admin: boolean; + }; + /** Format: uri */ + url: string; + /** Format: uri */ + html_url: string; + members_url: string; + /** Format: uri */ + repositories_url: string; + parent: null | components["schemas"]["team-simple"]; + }; + /** + * Enterprise Team + * @description Group of enterprise owners and/or members + */ + "enterprise-team": { + /** Format: int64 */ + id: number; + name: string; + slug: string; + /** Format: uri */ + url: string; + sync_to_organizations: string; + group_id?: string | null; + /** Format: uri */ + html_url: string; + members_url: string; + /** Format: date-time */ + created_at: string; + /** Format: date-time */ + updated_at: string; + }; + /** + * Copilot Business Seat Detail + * @description Information about a Copilot Business seat assignment for a user, team, or organization. + */ + "copilot-seat-details": { + assignee: components["schemas"]["simple-user"]; + organization?: null | components["schemas"]["organization-simple"]; + /** @description The team through which the assignee is granted access to GitHub Copilot, if applicable. */ + assigning_team?: (null | Record) & (components["schemas"]["team"] | components["schemas"]["enterprise-team"]); + /** + * Format: date + * @description The pending cancellation date for the seat, in `YYYY-MM-DD` format. This will be null unless the assignee's Copilot access has been canceled during the current billing cycle. If the seat has been cancelled, this corresponds to the start of the organization's next billing cycle. + */ + pending_cancellation_date?: string | null; + /** + * Format: date-time + * @description Timestamp of user's last GitHub Copilot activity, in ISO 8601 format. + */ + last_activity_at?: string | null; + /** @description Last editor that was used by the user for a GitHub Copilot completion. */ + last_activity_editor?: string | null; + /** + * Format: date-time + * @description Timestamp of when the assignee was last granted access to GitHub Copilot, in ISO 8601 format. + */ + created_at: string; + /** + * Format: date-time + * @deprecated + * @description **Closing down notice:** This field is no longer relevant and is closing down. Use the `created_at` field to determine when the assignee was last granted access to GitHub Copilot. Timestamp of when the assignee's GitHub Copilot access was last updated, in ISO 8601 format. + */ + updated_at?: string; + /** + * @description The Copilot plan of the organization, or the parent enterprise, when applicable. + * @enum {string} + */ + plan_type?: "business" | "enterprise" | "unknown"; + }; + /** @description Usage metrics for Copilot editor code completions in the IDE. */ + "copilot-ide-code-completions": ({ + /** @description Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances. */ + total_engaged_users?: number; + /** @description Code completion metrics for active languages. */ + languages?: { + /** @description Name of the language used for Copilot code completion suggestions. */ + name?: string; + /** @description Number of users who accepted at least one Copilot code completion suggestion for the given language. Includes both full and partial acceptances. */ + total_engaged_users?: number; + }[]; + editors?: ({ + /** @description Name of the given editor. */ + name?: string; + /** @description Number of users who accepted at least one Copilot code completion suggestion for the given editor. Includes both full and partial acceptances. */ + total_engaged_users?: number; + /** @description List of model metrics for custom models and the default model. */ + models?: { + /** @description Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'. */ + name?: string; + /** @description Indicates whether a model is custom or default. */ + is_custom_model?: boolean; + /** @description The training date for the custom model. */ + custom_model_training_date?: string | null; + /** @description Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances. */ + total_engaged_users?: number; + /** @description Code completion metrics for active languages, for the given editor. */ + languages?: { + /** @description Name of the language used for Copilot code completion suggestions, for the given editor. */ + name?: string; + /** @description Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language. Includes both full and partial acceptances. */ + total_engaged_users?: number; + /** @description The number of Copilot code suggestions generated for the given editor, for the given language. */ + total_code_suggestions?: number; + /** @description The number of Copilot code suggestions accepted for the given editor, for the given language. Includes both full and partial acceptances. */ + total_code_acceptances?: number; + /** @description The number of lines of code suggested by Copilot code completions for the given editor, for the given language. */ + total_code_lines_suggested?: number; + /** @description The number of lines of code accepted from Copilot code suggestions for the given editor, for the given language. */ + total_code_lines_accepted?: number; + }[]; + }[]; + } & { + [key: string]: unknown; + })[]; + } & { + [key: string]: unknown; + }) | null; + /** @description Usage metrics for Copilot Chat in the IDE. */ + "copilot-ide-chat": ({ + /** @description Total number of users who prompted Copilot Chat in the IDE. */ + total_engaged_users?: number; + editors?: { + /** @description Name of the given editor. */ + name?: string; + /** @description The number of users who prompted Copilot Chat in the specified editor. */ + total_engaged_users?: number; + /** @description List of model metrics for custom models and the default model. */ + models?: { + /** @description Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'. */ + name?: string; + /** @description Indicates whether a model is custom or default. */ + is_custom_model?: boolean; + /** @description The training date for the custom model. */ + custom_model_training_date?: string | null; + /** @description The number of users who prompted Copilot Chat in the given editor and model. */ + total_engaged_users?: number; + /** @description The total number of chats initiated by users in the given editor and model. */ + total_chats?: number; + /** @description The number of times users accepted a code suggestion from Copilot Chat using the 'Insert Code' UI element, for the given editor. */ + total_chat_insertion_events?: number; + /** @description The number of times users copied a code suggestion from Copilot Chat using the keyboard, or the 'Copy' UI element, for the given editor. */ + total_chat_copy_events?: number; + }[]; + }[]; + } & { + [key: string]: unknown; + }) | null; + /** @description Usage metrics for Copilot Chat in github.com */ + "copilot-dotcom-chat": ({ + /** @description Total number of users who prompted Copilot Chat on github.com at least once. */ + total_engaged_users?: number; + /** @description List of model metrics for a custom models and the default model. */ + models?: { + /** @description Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'. */ + name?: string; + /** @description Indicates whether a model is custom or default. */ + is_custom_model?: boolean; + /** @description The training date for the custom model (if applicable). */ + custom_model_training_date?: string | null; + /** @description Total number of users who prompted Copilot Chat on github.com at least once for each model. */ + total_engaged_users?: number; + /** @description Total number of chats initiated by users on github.com. */ + total_chats?: number; + }[]; + } & { + [key: string]: unknown; + }) | null; + /** @description Usage metrics for Copilot for pull requests. */ + "copilot-dotcom-pull-requests": ({ + /** @description The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once. */ + total_engaged_users?: number; + /** @description Repositories in which users used Copilot for Pull Requests to generate pull request summaries */ + repositories?: { + /** @description Repository name */ + name?: string; + /** @description The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository. */ + total_engaged_users?: number; + /** @description List of model metrics for custom models and the default model. */ + models?: { + /** @description Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'. */ + name?: string; + /** @description Indicates whether a model is custom or default. */ + is_custom_model?: boolean; + /** @description The training date for the custom model. */ + custom_model_training_date?: string | null; + /** @description The number of pull request summaries generated using Copilot for Pull Requests in the given repository. */ + total_pr_summaries_created?: number; + /** @description The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository and model. */ + total_engaged_users?: number; + }[]; + }[]; + } & { + [key: string]: unknown; + }) | null; + /** + * Copilot Usage Metrics + * @description Copilot usage metrics for a given day. + */ + "copilot-usage-metrics-day": { + /** + * Format: date + * @description The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format. + */ + date: string; + /** @description The total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint. */ + total_active_users?: number; + /** @description The total number of Copilot users who engaged with any Copilot feature, for the given day. Examples include but are not limited to accepting a code suggestion, prompting Copilot chat, or triggering a PR Summary. Does not include authentication events. Is not limited to the individual features detailed on the endpoint. */ + total_engaged_users?: number; + copilot_ide_code_completions?: components["schemas"]["copilot-ide-code-completions"]; + copilot_ide_chat?: components["schemas"]["copilot-ide-chat"]; + copilot_dotcom_chat?: components["schemas"]["copilot-dotcom-chat"]; + copilot_dotcom_pull_requests?: components["schemas"]["copilot-dotcom-pull-requests"]; + } & { + [key: string]: unknown; + }; + /** + * Copilot Usage Metrics + * @description Summary of Copilot usage. + */ + "copilot-usage-metrics": { + /** + * Format: date + * @description The date for which the usage metrics are reported, in `YYYY-MM-DD` format. + */ + day: string; + /** @description The total number of Copilot code completion suggestions shown to users. */ + total_suggestions_count?: number; + /** @description The total number of Copilot code completion suggestions accepted by users. */ + total_acceptances_count?: number; + /** @description The total number of lines of code completions suggested by Copilot. */ + total_lines_suggested?: number; + /** @description The total number of lines of code completions accepted by users. */ + total_lines_accepted?: number; + /** @description The total number of users who were shown Copilot code completion suggestions during the day specified. */ + total_active_users?: number; + /** @description The total instances of users who accepted code suggested by Copilot Chat in the IDE (panel and inline). */ + total_chat_acceptances?: number; + /** @description The total number of chat turns (prompt and response pairs) sent between users and Copilot Chat in the IDE. */ + total_chat_turns?: number; + /** @description The total number of users who interacted with Copilot Chat in the IDE during the day specified. */ + total_active_chat_users?: number; + /** @description Breakdown of Copilot code completions usage by language and editor */ + breakdown: ({ + /** @description The language in which Copilot suggestions were shown to users in the specified editor. */ + language?: string; + /** @description The editor in which Copilot suggestions were shown to users for the specified language. */ + editor?: string; + /** @description The number of Copilot suggestions shown to users in the editor specified during the day specified. */ + suggestions_count?: number; + /** @description The number of Copilot suggestions accepted by users in the editor specified during the day specified. */ + acceptances_count?: number; + /** @description The number of lines of code suggested by Copilot in the editor specified during the day specified. */ + lines_suggested?: number; + /** @description The number of lines of code accepted by users in the editor specified during the day specified. */ + lines_accepted?: number; + /** @description The number of users who were shown Copilot completion suggestions in the editor specified during the day specified. */ + active_users?: number; + } & { + [key: string]: unknown; + })[] | null; + }; /** * Dependabot Secret for an Organization * @description Secrets for GitHub Dependabot for an organization. @@ -27839,6 +28239,16 @@ export interface components { name: string; /** @description A short description about who this role is for or what permissions it grants. */ description?: string | null; + /** + * @description The system role from which this role inherits permissions. + * @enum {string|null} + */ + base_role?: "read" | "triage" | "write" | "maintain" | "admin" | null; + /** + * @description Source answers the question, "where did this role come from?" + * @enum {string|null} + */ + source?: "Organization" | "Enterprise" | "Predefined" | null; /** @description A list of permissions included in this role. */ permissions: string[]; organization: null | components["schemas"]["simple-user"]; @@ -27858,6 +28268,11 @@ export interface components { * @description The Relationship a Team has with a role. */ "team-role-assignment": { + /** + * @description Determines if the team has a direct, indirect, or mixed relationship to a role + * @enum {string} + */ + assignment?: "direct" | "indirect" | "mixed"; id: number; node_id: string; name: string; @@ -27887,6 +28302,13 @@ export interface components { * @description The Relationship a User has with a role. */ "user-role-assignment": { + /** + * @description Determines if the user has a direct, indirect, or mixed relationship to a role + * @enum {string} + */ + assignment?: "direct" | "indirect" | "mixed"; + /** @description Team the user has gotten the role through */ + inherited_from?: components["schemas"]["team-simple"][]; name?: string | null; email?: string | null; login: string; @@ -28034,6 +28456,56 @@ export interface components { /** @description Date and time when the associated fine-grained personal access token was last used for authentication. */ token_last_used_at: string | null; }; + /** + * Organization private registry + * @description Private registry configuration for an organization + */ + "org-private-registry-configuration": { + /** @description The name of the private registry configuration. */ + name: string; + /** + * @description The registry type. + * @enum {string} + */ + registry_type: "maven_repository"; + /** @description The username to use when authenticating with the private registry. */ + username?: string | null; + /** + * @description Which type of organization repositories have access to the private registry. + * @enum {string} + */ + visibility: "all" | "private" | "selected"; + /** Format: date-time */ + created_at: string; + /** Format: date-time */ + updated_at: string; + }; + /** + * Organization private registry + * @description Private registry configuration for an organization + */ + "org-private-registry-configuration-with-selected-repositories": { + /** @description The name of the private registry configuration. */ + name: string; + /** + * @description The registry type. + * @enum {string} + */ + registry_type: "maven_repository"; + /** @description The username to use when authenticating with the private registry. */ + username?: string; + /** + * @description Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry. + * @enum {string} + */ + visibility: "all" | "private" | "selected"; + /** @description An array of repository IDs that can access the organization private registry when `visibility` is set to `selected`. */ + selected_repository_ids?: number[]; + /** Format: date-time */ + created_at: string; + /** Format: date-time */ + updated_at: string; + }; /** * Project * @description Projects are a way to organize columns and cards of work. @@ -28081,6 +28553,11 @@ export interface components { * @description The URL that can be used to fetch, update, or delete info about this property via the API. */ url?: string; + /** + * @description The source type of the property + * @enum {string} + */ + source_type?: "organization" | "enterprise"; /** * @description The type of the value for the property * @enum {string} @@ -28101,6 +28578,26 @@ export interface components { */ values_editable_by?: "org_actors" | "org_and_repo_actors" | null; }; + /** + * Custom Property Set Payload + * @description Custom property set payload + */ + "custom-property-set-payload": { + /** + * @description The type of the value for the property + * @enum {string} + */ + value_type: "string" | "single_select" | "multi_select" | "true_false"; + /** @description Whether the property is required. */ + required?: boolean; + /** @description Default value of the property */ + default_value?: (null | unknown[]) & (string | string[]); + /** @description Short description of the property */ + description?: string | null; + /** @description An ordered list of the allowed values of the property. + * The property can have up to 200 allowed values. */ + allowed_values?: string[] | null; + }; /** * Custom Property Value * @description Custom property name and associated value @@ -28403,6 +28900,7 @@ export interface components { * @description Conditions for an organization ruleset. * The branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties. * The push rulesets conditions object does not require the `ref_name` property. + * For repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`. */ "org-ruleset-conditions": (components["schemas"]["repository-ruleset-conditions"] & components["schemas"]["repository-ruleset-conditions-repository-name-target"]) | (components["schemas"]["repository-ruleset-conditions"] & components["schemas"]["repository-ruleset-conditions-repository-id-target"]) | (components["schemas"]["repository-ruleset-conditions"] & components["schemas"]["repository-ruleset-conditions-repository-property-target"]); /** @@ -28511,6 +29009,8 @@ export interface components { /** @enum {string} */ type: "pull_request"; parameters?: { + /** @description When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled. */ + allowed_merge_methods?: string[]; /** @description New, reviewable commits pushed will dismiss previous pull request review approvals. */ dismiss_stale_reviews_on_push: boolean; /** @description Require an approving review in pull requests that modify files that have a designated code owner. */ @@ -28776,12 +29276,12 @@ export interface components { * @description The target of the ruleset * @enum {string} */ - target?: "branch" | "tag" | "push"; + target?: "branch" | "tag" | "push" | "repository"; /** * @description The type of the source of the ruleset * @enum {string} */ - source_type?: "Repository" | "Organization"; + source_type?: "Repository" | "Organization" | "Enterprise"; /** @description The name of the source */ source: string; enforcement: components["schemas"]["repository-rule-enforcement"]; @@ -29598,6 +30098,7 @@ export interface components { actions_runner_registration?: components["schemas"]["rate-limit"]; scim?: components["schemas"]["rate-limit"]; dependency_snapshots?: components["schemas"]["rate-limit"]; + code_scanning_autofix?: components["schemas"]["rate-limit"]; }; rate: components["schemas"]["rate-limit"]; }; @@ -30408,6 +30909,7 @@ export interface components { reason: string; payload: string | null; signature: string | null; + verified_at?: string | null; }; /** * Diff Entry @@ -30785,6 +31287,36 @@ export interface components { * @enum {string} */ "code-scanning-alert-set-state": "open" | "dismissed"; + /** + * @description The status of an autofix. + * @enum {string} + */ + "code-scanning-autofix-status": "pending" | "error" | "success" | "outdated"; + /** @description The description of an autofix. */ + "code-scanning-autofix-description": string | null; + /** + * Format: date-time + * @description The start time of an autofix in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + "code-scanning-autofix-started-at": string; + "code-scanning-autofix": { + status: components["schemas"]["code-scanning-autofix-status"]; + description: components["schemas"]["code-scanning-autofix-description"]; + started_at: components["schemas"]["code-scanning-autofix-started-at"]; + }; + /** @description Commit an autofix for a code scanning alert */ + "code-scanning-autofix-commits": { + /** @description The Git reference of target branch for the commit. Branch needs to already exist. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ + target_ref?: string; + /** @description Commit message to be used. */ + message?: string; + } | null; + "code-scanning-autofix-commits-response": { + /** @description The Git reference of target branch for the commit. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ + target_ref?: string; + /** @description SHA of commit with autofix. */ + sha?: string; + }; /** @description An identifier for the upload. */ "code-scanning-analysis-sarif-id": string; /** @description The SHA of the commit to which the analysis you are uploading relates. */ @@ -30988,7 +31520,7 @@ export interface components { */ state?: "configured" | "not-configured"; /** @description Languages to be analyzed. */ - languages?: ("c-cpp" | "csharp" | "go" | "java-kotlin" | "javascript-typescript" | "javascript" | "python" | "ruby" | "typescript" | "swift")[]; + languages?: ("actions" | "c-cpp" | "csharp" | "go" | "java-kotlin" | "javascript-typescript" | "javascript" | "python" | "ruby" | "typescript" | "swift")[]; /** * @description CodeQL query suite to be used. * @enum {string} @@ -31012,13 +31544,20 @@ export interface components { * @enum {string} */ state?: "configured" | "not-configured"; + /** + * @description Runner type to be used. + * @enum {string} + */ + runner_type?: "standard" | "labeled"; + /** @description Runner label to be used if the runner type is labeled. */ + runner_label?: string | null; /** * @description CodeQL query suite to be used. * @enum {string} */ query_suite?: "default" | "extended"; /** @description CodeQL languages to be analyzed. */ - languages?: ("c-cpp" | "csharp" | "go" | "java-kotlin" | "javascript-typescript" | "python" | "ruby" | "swift")[]; + languages?: ("actions" | "c-cpp" | "csharp" | "go" | "java-kotlin" | "javascript-typescript" | "python" | "ruby" | "swift")[]; }; /** @description You can use `run_url` to track the status of the run. This includes a property status and conclusion. * You should not rely on this always being an actions workflow run object. */ @@ -31667,6 +32206,7 @@ export interface components { reason?: string; signature?: string | null; payload?: string | null; + verified_at?: string | null; }; }; }; @@ -32194,6 +32734,7 @@ export interface components { reason: string; signature: string | null; payload: string | null; + verified_at?: string | null; }; /** Format: uri */ html_url: string; @@ -32871,6 +33412,7 @@ export interface components { reason: string; signature: string | null; payload: string | null; + verified_at?: string | null; }; /** Format: uri */ html_url: string; @@ -33681,6 +34223,16 @@ export interface components { * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ push_protection_bypassed_at?: string | null; + push_protection_bypass_request_reviewer?: null | components["schemas"]["simple-user"]; + /** @description An optional comment when reviewing a push protection bypass. */ + push_protection_bypass_request_reviewer_comment?: string | null; + /** @description An optional comment when requesting a push protection bypass. */ + push_protection_bypass_request_comment?: string | null; + /** + * Format: uri + * @description The URL to a push protection bypass request. + */ + push_protection_bypass_request_html_url?: string | null; /** * @description The token status as of the latest validity check. * @enum {string} @@ -33846,6 +34398,34 @@ export interface components { /** @description The token type this bypass is for. */ token_type?: string; }; + /** @description Information on a single scan performed by secret scanning on the repository */ + "secret-scanning-scan": { + /** @description The type of scan */ + type?: string; + /** @description The state of the scan. Either "completed", "running", or "pending" */ + status?: string; + /** + * Format: date-time + * @description The time that the scan was completed. Empty if the scan is running + */ + completed_at?: string | null; + /** + * Format: date-time + * @description The time that the scan was started. Empty if the scan is pending + */ + started_at?: string | null; + }; + "secret-scanning-scan-history": { + incremental_scans?: components["schemas"]["secret-scanning-scan"][]; + pattern_update_scans?: components["schemas"]["secret-scanning-scan"][]; + backfill_scans?: components["schemas"]["secret-scanning-scan"][]; + custom_pattern_backfill_scans?: (components["schemas"]["secret-scanning-scan"] & { + /** @description Name of the custom pattern for custom pattern scans */ + pattern_name?: string; + /** @description Level at which the custom pattern is defined, one of "repository", "organization", or "enterprise" */ + pattern_scope?: string; + })[]; + }; "repository-advisory-create": { /** @description A short summary of the advisory. */ summary: string; @@ -34221,6 +34801,12 @@ export interface components { default?: boolean; description?: string | null; }[]; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; state: string; state_reason?: string | null; assignee: null | components["schemas"]["simple-user"]; @@ -36421,6 +37007,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -36909,6 +37501,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -39445,6 +40043,16 @@ export interface components { * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ push_protection_bypassed_at?: string | null; + push_protection_bypass_request_reviewer?: null | components["schemas"]["simple-user"]; + /** @description An optional comment when reviewing a push protection bypass. */ + push_protection_bypass_request_reviewer_comment?: string | null; + /** @description An optional comment when requesting a push protection bypass. */ + push_protection_bypass_request_comment?: string | null; + /** + * Format: uri + * @description The URL to a push protection bypass request. + */ + push_protection_bypass_request_html_url?: string | null; /** @description Whether the detected secret was publicly leaked. */ publicly_leaked?: boolean | null; /** @description Whether the detected secret was found in multiple repositories in the same organization or business. */ @@ -44963,6 +45571,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -45501,6 +46115,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -46041,6 +46661,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -46596,6 +47222,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -47082,6 +47714,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -47506,6 +48144,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -47943,6 +48587,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -48369,6 +49019,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -48797,6 +49453,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -49221,6 +49883,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -49647,6 +50315,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -50313,6 +50987,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -50748,6 +51428,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -51173,6 +51859,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -51881,6 +52573,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -83108,6 +83806,45 @@ export interface components { repository: components["schemas"]["repository-webhooks"]; sender?: components["schemas"]["simple-user"]; }; + /** secret_scanning_scan completed event */ + "webhook-secret-scanning-scan-completed": { + /** @enum {string} */ + action: "completed"; + /** + * @description What type of scan was completed + * @enum {string} + */ + type: "backfill" | "custom-pattern-backfill" | "pattern-version-backfill"; + /** + * @description What type of content was scanned + * @enum {string} + */ + source: "git" | "issues" | "pull-requests" | "discussions" | "wiki"; + /** + * Format: date-time + * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + started_at: string; + /** + * Format: date-time + * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + completed_at: string; + /** @description List of patterns that were updated. This will be empty for normal backfill scans or custom pattern updates */ + secret_types?: string[] | null; + /** @description If the scan was triggered by a custom pattern update, this will be the name of the pattern that was updated */ + custom_pattern_name?: string | null; + /** + * @description If the scan was triggered by a custom pattern update, this will be the scope of the pattern that was updated + * @enum {string|null} + */ + custom_pattern_scope?: "repository" | "organization" | "enterprise" | null; + repository?: components["schemas"]["repository-webhooks"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + sender?: components["schemas"]["simple-user"]; + }; /** security_advisory published event */ "webhook-security-advisory-published": { /** @enum {string} */ @@ -83387,6 +84124,7 @@ export interface components { reason: "expired_key" | "not_signing_key" | "gpgverify_error" | "gpgverify_unavailable" | "unsigned" | "unknown_signature_type" | "no_user" | "unverified_email" | "bad_email" | "unknown_key" | "malformed_signature" | "invalid" | "valid" | "bad_cert" | "ocsp_pending"; signature: string | null; verified: boolean; + verified_at?: string | null; }; }; /** User */ @@ -86579,8 +87317,8 @@ export interface components { "application/json": components["schemas"]["basic-error"]; }; }; - /** @description Internal Error */ - internal_error: { + /** @description Conflict */ + conflict: { headers: { [name: string]: unknown; }; @@ -86588,14 +87326,12 @@ export interface components { "application/json": components["schemas"]["basic-error"]; }; }; - /** @description Copilot Usage Merics API setting is disabled at the organization or enterprise level. */ - usage_metrics_api_disabled: { + /** @description A header with no content is returned. */ + no_content: { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["basic-error"]; - }; + content?: never; }; /** @description Service unavailable */ service_unavailable: { @@ -86636,8 +87372,17 @@ export interface components { "application/json": components["schemas"]["basic-error"]; }; }; - /** @description Conflict */ - conflict: { + /** @description Billing usage report response for an organization */ + billing_usage_report_org: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["billing-usage-report"]; + }; + }; + /** @description Internal Error */ + internal_error: { headers: { [name: string]: unknown; }; @@ -86682,12 +87427,14 @@ export interface components { }; }; }; - /** @description A header with no content is returned. */ - no_content: { + /** @description Copilot Usage Merics API setting is disabled at the organization or enterprise level. */ + usage_metrics_api_disabled: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["basic-error"]; + }; }; /** @description The value of `per_page` multiplied by `page` cannot be greater than 10000. */ package_es_list_error: { @@ -86732,6 +87479,24 @@ export interface components { "application/json": components["schemas"]["basic-error"]; }; }; + /** @description Bad Request */ + code_scanning_bad_request: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + /** @description Response if the repository is archived, if GitHub Advanced Security is not enabled for this repository or if rate limit is exceeded */ + code_scanning_autofix_create_forbidden: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; /** @description Found */ found: { headers: { @@ -86805,6 +87570,8 @@ export interface components { "classroom-id": number; /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: string; + /** @description The unique identifier of the code security configuration. */ + "configuration-id": number; /** @description A comma-separated list of states. If specified, only alerts with these states will be returned. * * Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` */ @@ -86835,9 +87602,7 @@ export interface components { "pagination-last": number; /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ "secret-scanning-alert-state": "open" | "resolved"; - /** @description A comma-separated list of secret types to return. By default all secret types are returned. - * See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" - * for a complete list of secret types. */ + /** @description A comma-separated list of secret types to return. All default secret patterns are returned. To return experimental patterns, pass the token name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. */ "secret-scanning-alert-secret-type": string; /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ "secret-scanning-alert-resolution": string; @@ -86849,10 +87614,6 @@ export interface components { "secret-scanning-alert-publicly-leaked": boolean; /** @description A boolean value representing whether or not to filter alerts by the multi-repo tag being present. */ "secret-scanning-alert-multi-repo": boolean; - /** @description The slug of the enterprise team name. */ - "enterprise-team-slug": string; - /** @description The slug of the team name. */ - "team-slug": string; /** @description The unique identifier of the gist. */ "gist-id": string; /** @description The unique identifier of the comment. */ @@ -86881,6 +87642,14 @@ export interface components { "since-org": number; /** @description The organization name. The name is not case sensitive. */ org: string; + /** @description If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2024`. Default value is the current year. */ + "billing-usage-report-year": number; + /** @description If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. */ + "billing-usage-report-month": number; + /** @description If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. */ + "billing-usage-report-day": number; + /** @description If specified, only return results for a single hour. The value of `hour` is an integer between `0` and `23`. */ + "billing-usage-report-hour": number; /** @description The unique identifier of the repository. */ "repository-id": number; /** @description Only return runner groups that are allowed to be used by this repository. */ @@ -86903,26 +87672,30 @@ export interface components { "tool-name": components["schemas"]["code-scanning-analysis-tool-name"]; /** @description The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both. */ "tool-guid": components["schemas"]["code-scanning-analysis-tool-guid"]; - /** @description The unique identifier of the code security configuration. */ - "configuration-id": number; /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ "hook-id": number; /** @description The type of the actor */ - "api-insights-actor-type": "installations" | "classic_pats" | "fine_grained_pats" | "oauth_apps" | "github_apps_user_to_server"; + "api-insights-actor-type": "installation" | "classic_pat" | "fine_grained_pat" | "oauth_app" | "github_app_user_to_server"; /** @description The ID of the actor */ "api-insights-actor-id": number; - /** @description The minimum timestamp to query for stats */ + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ "api-insights-min-timestamp": string; - /** @description The maximum timestamp to query for stats */ + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ "api-insights-max-timestamp": string; /** @description The property to sort the results by. */ "api-insights-route-stats-sort": ("last_rate_limited_timestamp" | "last_request_timestamp" | "rate_limited_request_count" | "http_method" | "api_route" | "total_request_count")[]; + /** @description Providing a substring will filter results where the API route contains the substring. This is a case-insensitive search. */ + "api-insights-api-route-substring": string; /** @description The property to sort the results by. */ "api-insights-sort": ("last_rate_limited_timestamp" | "last_request_timestamp" | "rate_limited_request_count" | "subject_name" | "total_request_count")[]; + /** @description Providing a substring will filter results where the subject name contains the substring. This is a case-insensitive search. */ + "api-insights-subject-name-substring": string; /** @description The ID of the user to query for stats */ "api-insights-user-id": string; /** @description The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) */ "api-insights-timestamp-increment": string; + /** @description Providing a substring will filter results where the actor name contains the substring. This is a case-insensitive search. */ + "api-insights-actor-name-substring": string; /** @description The unique identifier of the invitation. */ "invitation-id": number; /** @description The name of the codespace. */ @@ -86931,6 +87704,8 @@ export interface components { "migration-id": number; /** @description repo_name parameter */ "repo-name": string; + /** @description The slug of the team name. */ + "team-slug": string; /** @description The unique identifier of the role. */ "role-id": number; /** @description The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -86967,8 +87742,8 @@ export interface components { "ruleset-targets": string; /** @description The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. */ "ref-in-query": string; - /** @description The name of the repository to filter on. When specified, only rule evaluations from this repository will be returned. */ - "repository-name-in-query": number; + /** @description The name of the repository to filter on. */ + "repository-name-in-query": string; /** @description The time period to filter by. * * For example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for insights that occurred in the past 7 days (168 hours). */ @@ -88034,13 +88809,15 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; - "copilot/list-copilot-seats-for-enterprise": { + "code-security/get-configurations-for-enterprise": { parameters: { query?: { - /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - page?: components["parameters"]["page"]; /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: number; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + before?: components["parameters"]["pagination-before"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + after?: components["parameters"]["pagination-after"]; }; header?: never; path: { @@ -88054,39 +88831,164 @@ export interface operations { /** @description Response */ 200: { headers: { - Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": { - /** @description The total number of Copilot seats the enterprise is being billed for. Users with access through multiple organizations or enterprise teams are only counted once. */ - total_seats?: number; - seats?: components["schemas"]["copilot-seat-details"][]; + "application/json": components["schemas"]["code-security-configuration"][]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "code-security/create-configuration-for-enterprise": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + enterprise: components["parameters"]["enterprise"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description The name of the code security configuration. Must be unique within the enterprise. */ + name: string; + /** @description A description of the code security configuration */ + description: string; + /** + * @description The enablement status of GitHub Advanced Security + * @default disabled + * @enum {string} + */ + advanced_security?: "enabled" | "disabled"; + /** + * @description The enablement status of Dependency Graph + * @default enabled + * @enum {string} + */ + dependency_graph?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Automatic dependency submission + * @default disabled + * @enum {string} + */ + dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for Automatic dependency submission */ + dependency_graph_autosubmit_action_options?: { + /** + * @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. + * @default false + */ + labeled_runners?: boolean; }; + /** + * @description The enablement status of Dependabot alerts + * @default disabled + * @enum {string} + */ + dependabot_alerts?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot security updates + * @default disabled + * @enum {string} + */ + dependabot_security_updates?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of code scanning default setup + * @default disabled + * @enum {string} + */ + code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; + code_scanning_default_setup_options?: components["schemas"]["code-scanning-default-setup-options"]; + /** + * @description The enablement status of secret scanning + * @default disabled + * @enum {string} + */ + secret_scanning?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning push protection + * @default disabled + * @enum {string} + */ + secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning validity checks + * @default disabled + * @enum {string} + */ + secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning non provider patterns + * @default disabled + * @enum {string} + */ + secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of private vulnerability reporting + * @default disabled + * @enum {string} + */ + private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; + /** + * @description The enforcement status for a security configuration + * @default enforced + * @enum {string} + */ + enforcement?: "enforced" | "unenforced"; }; }; - 401: components["responses"]["requires_authentication"]; + }; + responses: { + /** @description Successfully created code security configuration */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["code-security-configuration"]; + }; + }; + 400: components["responses"]["bad_request"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; }; }; - "copilot/copilot-metrics-for-enterprise": { + "code-security/get-default-configurations-for-enterprise": { parameters: { - query?: { - /** @description Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago. */ - since?: string; - /** @description Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed. */ - until?: string; - /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - page?: components["parameters"]["page"]; - /** @description The number of days of metrics to display per page (max 28). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - per_page?: number; + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + enterprise: components["parameters"]["enterprise"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["code-security-default-configurations"]; + }; }; + }; + }; + "code-security/get-single-configuration-for-enterprise": { + parameters: { + query?: never; header?: never; path: { /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description The unique identifier of the code security configuration. */ + configuration_id: components["parameters"]["configuration-id"]; }; cookie?: never; }; @@ -88098,31 +89000,233 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["copilot-usage-metrics-day"][]; + "application/json": components["schemas"]["code-security-configuration"]; }; }; + 304: components["responses"]["not_modified"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - 422: components["responses"]["usage_metrics_api_disabled"]; - 500: components["responses"]["internal_error"]; }; }; - "copilot/usage-metrics-for-enterprise": { + "code-security/delete-configuration-for-enterprise": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The unique identifier of the code security configuration. */ + configuration_id: components["parameters"]["configuration-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 204: components["responses"]["no_content"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + }; + }; + "code-security/update-enterprise-configuration": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The unique identifier of the code security configuration. */ + configuration_id: components["parameters"]["configuration-id"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description The name of the code security configuration. Must be unique across the enterprise. */ + name?: string; + /** @description A description of the code security configuration */ + description?: string; + /** + * @description The enablement status of GitHub Advanced Security. Must be set to enabled if you want to enable any GHAS settings. + * @enum {string} + */ + advanced_security?: "enabled" | "disabled"; + /** + * @description The enablement status of Dependency Graph + * @enum {string} + */ + dependency_graph?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Automatic dependency submission + * @enum {string} + */ + dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for Automatic dependency submission */ + dependency_graph_autosubmit_action_options?: { + /** @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. */ + labeled_runners?: boolean; + }; + /** + * @description The enablement status of Dependabot alerts + * @enum {string} + */ + dependabot_alerts?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot security updates + * @enum {string} + */ + dependabot_security_updates?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of code scanning default setup + * @enum {string} + */ + code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; + code_scanning_default_setup_options?: components["schemas"]["code-scanning-default-setup-options"]; + /** + * @description The enablement status of secret scanning + * @enum {string} + */ + secret_scanning?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning push protection + * @enum {string} + */ + secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning validity checks + * @enum {string} + */ + secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning non-provider patterns + * @enum {string} + */ + secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of private vulnerability reporting + * @enum {string} + */ + private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; + /** + * @description The enforcement status for a security configuration + * @enum {string} + */ + enforcement?: "enforced" | "unenforced"; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["code-security-configuration"]; + }; + }; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + }; + }; + "code-security/attach-enterprise-configuration": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The unique identifier of the code security configuration. */ + configuration_id: components["parameters"]["configuration-id"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** + * @description The type of repositories to attach the configuration to. `selected` means the configuration will be attached to only the repositories specified by `selected_repository_ids` + * @enum {string} + */ + scope: "all" | "all_without_configurations"; + }; + }; + }; + responses: { + 202: components["responses"]["accepted"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + }; + }; + "code-security/set-configuration-as-default-for-enterprise": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The unique identifier of the code security configuration. */ + configuration_id: components["parameters"]["configuration-id"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** + * @description Specify which types of repository this security configuration should be applied to by default. + * @enum {string} + */ + default_for_new_repos?: "all" | "none" | "private_and_internal" | "public"; + }; + }; + }; + responses: { + /** @description Default successfully changed. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * @description Specifies which types of repository this security configuration is applied to by default. + * @enum {string} + */ + default_for_new_repos?: "all" | "none" | "private_and_internal" | "public"; + configuration?: components["schemas"]["code-security-configuration"]; + }; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "code-security/get-repositories-for-enterprise-configuration": { parameters: { query?: { - /** @description Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago. */ - since?: string; - /** @description Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed. */ - until?: string; - /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - page?: components["parameters"]["page"]; - /** @description The number of days of metrics to display per page (max 28). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: number; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + before?: components["parameters"]["pagination-before"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + after?: components["parameters"]["pagination-after"]; + /** @description A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned. + * + * Can be: `all`, `attached`, `attaching`, `removed`, `enforced`, `failed`, `updating`, `removed_by_enterprise` */ + status?: string; }; header?: never; path: { /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description The unique identifier of the code security configuration. */ + configuration_id: components["parameters"]["configuration-id"]; }; cookie?: never; }; @@ -88134,13 +89238,11 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["copilot-usage-metrics"][]; + "application/json": components["schemas"]["code-security-configuration-repositories"][]; }; }; - 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; }; }; "dependabot/list-alerts-for-enterprise": { @@ -88212,9 +89314,7 @@ export interface operations { query?: { /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ state?: components["parameters"]["secret-scanning-alert-state"]; - /** @description A comma-separated list of secret types to return. By default all secret types are returned. - * See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" - * for a complete list of secret types. */ + /** @description A comma-separated list of secret types to return. All default secret patterns are returned. To return experimental patterns, pass the token name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. */ secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ resolution?: components["parameters"]["secret-scanning-alert-resolution"]; @@ -88258,82 +89358,6 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - "copilot/copilot-metrics-for-enterprise-team": { - parameters: { - query?: { - /** @description Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago. */ - since?: string; - /** @description Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed. */ - until?: string; - /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - page?: components["parameters"]["page"]; - /** @description The number of days of metrics to display per page (max 28). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - per_page?: number; - }; - header?: never; - path: { - /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - /** @description The slug of the enterprise team name. */ - team_slug: components["parameters"]["enterprise-team-slug"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["copilot-usage-metrics-day"][]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["usage_metrics_api_disabled"]; - 500: components["responses"]["internal_error"]; - }; - }; - "copilot/usage-metrics-for-enterprise-team": { - parameters: { - query?: { - /** @description Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago. */ - since?: string; - /** @description Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed. */ - until?: string; - /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - page?: components["parameters"]["page"]; - /** @description The number of days of metrics to display per page (max 28). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - per_page?: number; - }; - header?: never; - path: { - /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - /** @description The slug of the team name. */ - team_slug: components["parameters"]["team-slug"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["copilot-usage-metrics"][]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; - }; - }; "activity/list-public-events": { parameters: { query?: { @@ -89757,6 +90781,34 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; + "billing/get-github-billing-usage-report-org": { + parameters: { + query?: { + /** @description If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2024`. Default value is the current year. */ + year?: components["parameters"]["billing-usage-report-year"]; + /** @description If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. */ + month?: components["parameters"]["billing-usage-report-month"]; + /** @description If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. */ + day?: components["parameters"]["billing-usage-report-day"]; + /** @description If specified, only return results for a single hour. The value of `hour` is an integer between `0` and `23`. */ + hour?: components["parameters"]["billing-usage-report-hour"]; + }; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["billing_usage_report_org"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 500: components["responses"]["internal_error"]; + 503: components["responses"]["service_unavailable"]; + }; + }; "orgs/get": { parameters: { query?: never; @@ -91651,6 +92703,7 @@ export interface operations { }; }; repository_id?: number; + bundle_url?: string; }[]; }; }; @@ -91906,6 +92959,7 @@ export interface operations { * @enum {string} */ code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; + code_scanning_default_setup_options?: components["schemas"]["code-scanning-default-setup-options"]; /** * @description The enablement status of secret scanning * @default disabled @@ -92131,6 +93185,7 @@ export interface operations { * @enum {string} */ code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; + code_scanning_default_setup_options?: components["schemas"]["code-scanning-default-setup-options"]; /** * @description The enablement status of secret scanning * @enum {string} @@ -93855,10 +94910,10 @@ export interface operations { "api-insights/get-route-stats-by-actor": { parameters: { query: { - /** @description The minimum timestamp to query for stats */ + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ min_timestamp: components["parameters"]["api-insights-min-timestamp"]; - /** @description The maximum timestamp to query for stats */ - max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ @@ -93867,6 +94922,8 @@ export interface operations { direction?: components["parameters"]["direction"]; /** @description The property to sort the results by. */ sort?: components["parameters"]["api-insights-route-stats-sort"]; + /** @description Providing a substring will filter results where the API route contains the substring. This is a case-insensitive search. */ + api_route_substring?: components["parameters"]["api-insights-api-route-substring"]; }; header?: never; path: { @@ -93895,10 +94952,10 @@ export interface operations { "api-insights/get-subject-stats": { parameters: { query: { - /** @description The minimum timestamp to query for stats */ + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ min_timestamp: components["parameters"]["api-insights-min-timestamp"]; - /** @description The maximum timestamp to query for stats */ - max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ @@ -93907,6 +94964,8 @@ export interface operations { direction?: components["parameters"]["direction"]; /** @description The property to sort the results by. */ sort?: components["parameters"]["api-insights-sort"]; + /** @description Providing a substring will filter results where the subject name contains the substring. This is a case-insensitive search. */ + subject_name_substring?: components["parameters"]["api-insights-subject-name-substring"]; }; header?: never; path: { @@ -93931,10 +94990,10 @@ export interface operations { "api-insights/get-summary-stats": { parameters: { query: { - /** @description The minimum timestamp to query for stats */ + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ min_timestamp: components["parameters"]["api-insights-min-timestamp"]; - /** @description The maximum timestamp to query for stats */ - max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; }; header?: never; path: { @@ -93959,10 +95018,10 @@ export interface operations { "api-insights/get-summary-stats-by-user": { parameters: { query: { - /** @description The minimum timestamp to query for stats */ + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ min_timestamp: components["parameters"]["api-insights-min-timestamp"]; - /** @description The maximum timestamp to query for stats */ - max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; }; header?: never; path: { @@ -93989,10 +95048,10 @@ export interface operations { "api-insights/get-summary-stats-by-actor": { parameters: { query: { - /** @description The minimum timestamp to query for stats */ + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ min_timestamp: components["parameters"]["api-insights-min-timestamp"]; - /** @description The maximum timestamp to query for stats */ - max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; }; header?: never; path: { @@ -94021,10 +95080,10 @@ export interface operations { "api-insights/get-time-stats": { parameters: { query: { - /** @description The minimum timestamp to query for stats */ + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ min_timestamp: components["parameters"]["api-insights-min-timestamp"]; - /** @description The maximum timestamp to query for stats */ - max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; /** @description The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) */ timestamp_increment: components["parameters"]["api-insights-timestamp-increment"]; }; @@ -94051,10 +95110,10 @@ export interface operations { "api-insights/get-time-stats-by-user": { parameters: { query: { - /** @description The minimum timestamp to query for stats */ + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ min_timestamp: components["parameters"]["api-insights-min-timestamp"]; - /** @description The maximum timestamp to query for stats */ - max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; /** @description The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) */ timestamp_increment: components["parameters"]["api-insights-timestamp-increment"]; }; @@ -94083,10 +95142,10 @@ export interface operations { "api-insights/get-time-stats-by-actor": { parameters: { query: { - /** @description The minimum timestamp to query for stats */ + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ min_timestamp: components["parameters"]["api-insights-min-timestamp"]; - /** @description The maximum timestamp to query for stats */ - max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; /** @description The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) */ timestamp_increment: components["parameters"]["api-insights-timestamp-increment"]; }; @@ -94117,10 +95176,10 @@ export interface operations { "api-insights/get-user-stats": { parameters: { query: { - /** @description The minimum timestamp to query for stats */ + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ min_timestamp: components["parameters"]["api-insights-min-timestamp"]; - /** @description The maximum timestamp to query for stats */ - max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ @@ -94129,6 +95188,8 @@ export interface operations { direction?: components["parameters"]["direction"]; /** @description The property to sort the results by. */ sort?: components["parameters"]["api-insights-sort"]; + /** @description Providing a substring will filter results where the actor name contains the substring. This is a case-insensitive search. */ + actor_name_substring?: components["parameters"]["api-insights-actor-name-substring"]; }; header?: never; path: { @@ -95992,6 +97053,217 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; + "private-registries/list-org-private-registries": { + parameters: { + query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + page?: components["parameters"]["page"]; + }; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": { + total_count: number; + configurations: components["schemas"]["org-private-registry-configuration"][]; + }; + }; + }; + 400: components["responses"]["bad_request"]; + 404: components["responses"]["not_found"]; + }; + }; + "private-registries/create-org-private-registry": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** + * @description The registry type. + * @enum {string} + */ + registry_type: "maven_repository"; + /** @description The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication. */ + username?: string | null; + /** @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint. */ + encrypted_value: string; + /** @description The ID of the key you used to encrypt the secret. */ + key_id: string; + /** + * @description Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry. + * @enum {string} + */ + visibility: "all" | "private" | "selected"; + /** @description An array of repository IDs that can access the organization private registry. You can only provide a list of repository IDs when `visibility` is set to `selected`. You can manage the list of selected repositories using the [Update a private registry for an organization](https://docs.github.com/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization) endpoint. This field should be omitted if `visibility` is set to `all` or `private`. */ + selected_repository_ids?: number[]; + }; + }; + }; + responses: { + /** @description The organization private registry configuration */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["org-private-registry-configuration-with-selected-repositories"]; + }; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "private-registries/get-org-public-key": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description The identifier for the key. */ + key_id: string; + /** @description The Base64 encoded public key. */ + key: string; + }; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + "private-registries/get-org-private-registry": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The name of the secret. */ + secret_name: components["parameters"]["secret-name"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description The specified private registry configuration for the organization */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["org-private-registry-configuration"]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + "private-registries/delete-org-private-registry": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The name of the secret. */ + secret_name: components["parameters"]["secret-name"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 400: components["responses"]["bad_request"]; + 404: components["responses"]["not_found"]; + }; + }; + "private-registries/update-org-private-registry": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The name of the secret. */ + secret_name: components["parameters"]["secret-name"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** + * @description The registry type. + * @enum {string} + */ + registry_type?: "maven_repository"; + /** @description The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication. */ + username?: string | null; + /** @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint. */ + encrypted_value?: string; + /** @description The ID of the key you used to encrypt the secret. */ + key_id?: string; + /** + * @description Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry. + * @enum {string} + */ + visibility?: "all" | "private" | "selected"; + /** @description An array of repository IDs that can access the organization private registry. You can only provide a list of repository IDs when `visibility` is set to `selected`. This field should be omitted if `visibility` is set to `all` or `private`. */ + selected_repository_ids?: number[]; + }; + }; + }; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; "projects/list-for-org": { parameters: { query?: { @@ -96159,22 +97431,7 @@ export interface operations { }; requestBody: { content: { - "application/json": { - /** - * @description The type of the value for the property - * @enum {string} - */ - value_type: "string" | "single_select" | "multi_select" | "true_false"; - /** @description Whether the property is required. */ - required?: boolean; - /** @description Default value of the property */ - default_value?: (null | unknown[]) & (string | string[]); - /** @description Short description of the property */ - description?: string | null; - /** @description An ordered list of the allowed values of the property. - * The property can have up to 200 allowed values. */ - allowed_values?: string[] | null; - }; + "application/json": components["schemas"]["custom-property-set-payload"]; }; }; responses: { @@ -96630,7 +97887,7 @@ export interface operations { * @default branch * @enum {string} */ - target?: "branch" | "tag" | "push"; + target?: "branch" | "tag" | "push" | "repository"; enforcement: components["schemas"]["repository-rule-enforcement"]; /** @description The actors that can bypass the rules in this ruleset */ bypass_actors?: components["schemas"]["repository-ruleset-bypass-actor"][]; @@ -96659,7 +97916,7 @@ export interface operations { query?: { /** @description The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. */ ref?: components["parameters"]["ref-in-query"]; - /** @description The name of the repository to filter on. When specified, only rule evaluations from this repository will be returned. */ + /** @description The name of the repository to filter on. */ repository_name?: components["parameters"]["repository-name-in-query"]; /** @description The time period to filter by. * @@ -96775,7 +98032,7 @@ export interface operations { * @description The target of the ruleset * @enum {string} */ - target?: "branch" | "tag" | "push"; + target?: "branch" | "tag" | "push" | "repository"; enforcement?: components["schemas"]["repository-rule-enforcement"]; /** @description The actors that can bypass the rules in this ruleset */ bypass_actors?: components["schemas"]["repository-ruleset-bypass-actor"][]; @@ -96829,9 +98086,7 @@ export interface operations { query?: { /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ state?: components["parameters"]["secret-scanning-alert-state"]; - /** @description A comma-separated list of secret types to return. By default all secret types are returned. - * See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" - * for a complete list of secret types. */ + /** @description A comma-separated list of secret types to return. All default secret patterns are returned. To return experimental patterns, pass the token name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. */ secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ resolution?: components["parameters"]["secret-scanning-alert-resolution"]; @@ -101800,6 +103055,7 @@ export interface operations { }; }; repository_id?: number; + bundle_url?: string; }[]; }; }; @@ -103841,16 +105097,85 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["code-scanning-alert"]; + "application/json": components["schemas"]["code-scanning-alert"]; + }; + }; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["code_scanning_forbidden_read"]; + 404: components["responses"]["not_found"]; + 503: components["responses"]["service_unavailable"]; + }; + }; + "code-scanning/update-alert": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The account owner of the repository. The name is not case sensitive. */ + owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ + repo: components["parameters"]["repo"]; + /** @description The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */ + alert_number: components["parameters"]["alert-number"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + state: components["schemas"]["code-scanning-alert-set-state"]; + dismissed_reason?: components["schemas"]["code-scanning-alert-dismissed-reason"]; + dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["code-scanning-alert"]; + }; + }; + 403: components["responses"]["code_scanning_forbidden_write"]; + 404: components["responses"]["not_found"]; + 503: components["responses"]["service_unavailable"]; + }; + }; + "code-scanning/get-autofix": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The account owner of the repository. The name is not case sensitive. */ + owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ + repo: components["parameters"]["repo"]; + /** @description The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */ + alert_number: components["parameters"]["alert-number"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["code-scanning-autofix"]; }; }; - 304: components["responses"]["not_modified"]; + 400: components["responses"]["code_scanning_bad_request"]; 403: components["responses"]["code_scanning_forbidden_read"]; 404: components["responses"]["not_found"]; 503: components["responses"]["service_unavailable"]; }; }; - "code-scanning/update-alert": { + "code-scanning/create-autofix": { parameters: { query?: never; header?: never; @@ -103864,27 +105189,78 @@ export interface operations { }; cookie?: never; }; - requestBody: { - content: { - "application/json": { - state: components["schemas"]["code-scanning-alert-set-state"]; - dismissed_reason?: components["schemas"]["code-scanning-alert-dismissed-reason"]; - dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["code-scanning-autofix"]; }; }; + /** @description Accepted */ + 202: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["code-scanning-autofix"]; + }; + }; + 400: components["responses"]["code_scanning_bad_request"]; + 403: components["responses"]["code_scanning_autofix_create_forbidden"]; + 404: components["responses"]["not_found"]; + /** @description Unprocessable Entity */ + 422: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 503: components["responses"]["service_unavailable"]; + }; + }; + "code-scanning/commit-autofix": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The account owner of the repository. The name is not case sensitive. */ + owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ + repo: components["parameters"]["repo"]; + /** @description The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */ + alert_number: components["parameters"]["alert-number"]; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": components["schemas"]["code-scanning-autofix-commits"]; + }; }; responses: { - /** @description Response */ - 200: { + /** @description Created */ + 201: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["code-scanning-alert"]; + "application/json": components["schemas"]["code-scanning-autofix-commits-response"]; }; }; + 400: components["responses"]["code_scanning_bad_request"]; 403: components["responses"]["code_scanning_forbidden_write"]; 404: components["responses"]["not_found"]; + /** @description Unprocessable Entity */ + 422: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; 503: components["responses"]["service_unavailable"]; }; }; @@ -110081,6 +111457,163 @@ export interface operations { }; }; }; + "issues/remove-sub-issue": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The account owner of the repository. The name is not case sensitive. */ + owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ + repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ + issue_number: components["parameters"]["issue-number"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description The sub-issue to remove */ + sub_issue_id: number; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + /** @example https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue */ + Location?: string; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["issue"]; + }; + }; + 400: components["responses"]["bad_request"]; + 404: components["responses"]["not_found"]; + }; + }; + "issues/list-sub-issues": { + parameters: { + query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + page?: components["parameters"]["page"]; + }; + header?: never; + path: { + /** @description The account owner of the repository. The name is not case sensitive. */ + owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ + repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ + issue_number: components["parameters"]["issue-number"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["issue"][]; + }; + }; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; + }; + }; + "issues/add-sub-issue": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The account owner of the repository. The name is not case sensitive. */ + owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ + repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ + issue_number: components["parameters"]["issue-number"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description The sub-issue to add */ + sub_issue_id: number; + /** @description Option that, when true, instructs the operation to replace the sub-issues current parent issue */ + replace_parent?: boolean; + }; + }; + }; + responses: { + /** @description Response */ + 201: { + headers: { + /** @example https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1 */ + Location?: string; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["issue"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "issues/reprioritize-sub-issue": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The account owner of the repository. The name is not case sensitive. */ + owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ + repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ + issue_number: components["parameters"]["issue-number"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description The id of the sub-issue to reprioritize */ + sub_issue_id: number; + /** @description The id of the sub-issue to be prioritized after (either positional argument after OR before should be specified). */ + after_id?: number; + /** @description The id of the sub-issue to be prioritized before (either positional argument after OR before should be specified). */ + before_id?: number; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["issue"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed_simple"]; + 503: components["responses"]["service_unavailable"]; + }; + }; "issues/list-events-for-timeline": { parameters: { query?: { @@ -113680,9 +115213,7 @@ export interface operations { query?: { /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ state?: components["parameters"]["secret-scanning-alert-state"]; - /** @description A comma-separated list of secret types to return. By default all secret types are returned. - * See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" - * for a complete list of secret types. */ + /** @description A comma-separated list of secret types to return. All default secret patterns are returned. To return experimental patterns, pass the token name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. */ secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ resolution?: components["parameters"]["secret-scanning-alert-resolution"]; @@ -113923,6 +115454,39 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; + "secret-scanning/get-scan-history": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The account owner of the repository. The name is not case sensitive. */ + owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ + repo: components["parameters"]["repo"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["secret-scanning-scan-history"]; + }; + }; + /** @description Repository does not have GitHub Advanced Security or secret scanning enabled */ + 404: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 503: components["responses"]["service_unavailable"]; + }; + }; "security-advisories/list-repository-advisories": { parameters: { query?: { @@ -119495,6 +121059,7 @@ export interface operations { attestations?: { bundle?: components["schemas"]["sigstore-bundle-0"]; repository_id?: number; + bundle_url?: string; }[]; }; }; @@ -128593,6 +130158,43 @@ export interface operations { }; }; }; + "secret-scanning-scan/completed": { + parameters: { + query?: never; + header?: { + /** @example GitHub-Hookshot/123abc */ + "User-Agent"?: string; + /** @example 12312312 */ + "X-Github-Hook-Id"?: string; + /** @example issues */ + "X-Github-Event"?: string; + /** @example 123123 */ + "X-Github-Hook-Installation-Target-Id"?: string; + /** @example repository */ + "X-Github-Hook-Installation-Target-Type"?: string; + /** @example 0b989ba4-242f-11e5-81e1-c7b6966d2516 */ + "X-GitHub-Delivery"?: string; + /** @example sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e */ + "X-Hub-Signature-256"?: string; + }; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["webhook-secret-scanning-scan-completed"]; + }; + }; + responses: { + /** @description Return a 200 status to indicate that the data was received successfully */ + 200: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; "security-advisory/published": { parameters: { query?: never; diff --git a/packages/openapi-typescript/examples/github-api-next.yaml b/packages/openapi-typescript/examples/github-api-next.yaml index dce3ddc78..e494f1288 100644 --- a/packages/openapi-typescript/examples/github-api-next.yaml +++ b/packages/openapi-typescript/examples/github-api-next.yaml @@ -731,8 +731,6 @@ paths: Optionally, use the `permissions` body parameter to specify the permissions that the installation access token should have. If `permissions` is not specified, the installation access token will have all of the permissions that were granted to the app. The installation access token cannot be granted permissions that the app was not granted. - When using the repository or permission parameters to reduce the access of the token, the complexity of the token is increased due to both the number of permissions in the request and the number of repositories the token will have access to. If the complexity is too large, the token will fail to be issued. If this occurs, the error message will indicate the maximum number of repositories that should be requested. For the average application requesting 8 permissions, this limit is around 5000 repositories. With fewer permissions requested, more repositories are supported. - You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. tags: - apps @@ -1435,200 +1433,660 @@ paths: enabledForGitHubApps: true category: emojis subcategory: emojis - "/enterprises/{enterprise}/copilot/billing/seats": + "/enterprises/{enterprise}/code-security/configurations": get: - summary: List all Copilot seat assignments for an enterprise + summary: Get code security configurations for an enterprise description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Lists all Copilot seats currently being billed for across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription. - - Users with access through multiple organizations or enterprise teams will only be counted toward `total_seats` once. - - For each organization or enterprise team which grants Copilot access to a user, a seat detail object will appear in the `seats` array. - Each seat object contains information about the assigned user's most recent Copilot activity. Users must have - telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. For more information about activity data, - see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." + Lists all code security configurations available in an enterprise. - Only enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams. + The authenticated user must be an administrator of the enterprise in order to use this endpoint. - Personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. tags: - - copilot - operationId: copilot/list-copilot-seats-for-enterprise + - code-security + operationId: code-security/get-configurations-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-user-management#list-all-copilot-seat-assignments-for-an-enterprise + url: https://docs.github.com/rest/code-security/configurations#get-code-security-configurations-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" - - "$ref": "#/components/parameters/page" - name: per_page + in: query description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." - in: query + required: false schema: type: integer - default: 50 + default: 30 + - "$ref": "#/components/parameters/pagination-before" + - "$ref": "#/components/parameters/pagination-after" responses: '200': description: Response content: application/json: schema: - type: object - properties: - total_seats: - type: integer - description: The total number of Copilot seats the enterprise - is being billed for. Users with access through multiple organizations - or enterprise teams are only counted once. - seats: - type: array - items: - "$ref": "#/components/schemas/copilot-seat-details" + type: array + items: + "$ref": "#/components/schemas/code-security-configuration" examples: default: - "$ref": "#/components/examples/copilot-seats-list" - headers: - Link: - "$ref": "#/components/headers/link" - '500': - "$ref": "#/components/responses/internal_error" - '401': - "$ref": "#/components/responses/requires_authentication" + "$ref": "#/components/examples/enterprise-code-security-configuration-list" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: code-security + subcategory: configurations + post: + summary: Create a code security configuration for an enterprise + description: |- + Creates a code security configuration in an enterprise. + + The authenticated user must be an administrator of the enterprise in order to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + tags: + - code-security + operationId: code-security/create-configuration-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/code-security/configurations#create-a-code-security-configuration-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + requestBody: + required: true + content: + application/json: + schema: + type: object + additionalProperties: false + properties: + name: + type: string + description: The name of the code security configuration. Must be + unique within the enterprise. + description: + type: string + description: A description of the code security configuration + maxLength: 255 + advanced_security: + type: string + description: The enablement status of GitHub Advanced Security + enum: + - enabled + - disabled + default: disabled + dependency_graph: + type: string + description: The enablement status of Dependency Graph + enum: + - enabled + - disabled + - not_set + default: enabled + dependency_graph_autosubmit_action: + type: string + description: The enablement status of Automatic dependency submission + enum: + - enabled + - disabled + - not_set + default: disabled + dependency_graph_autosubmit_action_options: + type: object + description: Feature options for Automatic dependency submission + properties: + labeled_runners: + type: boolean + description: Whether to use runners labeled with 'dependency-submission' + or standard GitHub runners. + default: false + dependabot_alerts: + type: string + description: The enablement status of Dependabot alerts + enum: + - enabled + - disabled + - not_set + default: disabled + dependabot_security_updates: + type: string + description: The enablement status of Dependabot security updates + enum: + - enabled + - disabled + - not_set + default: disabled + code_scanning_default_setup: + type: string + description: The enablement status of code scanning default setup + enum: + - enabled + - disabled + - not_set + default: disabled + code_scanning_default_setup_options: + "$ref": "#/components/schemas/code-scanning-default-setup-options" + secret_scanning: + type: string + description: The enablement status of secret scanning + enum: + - enabled + - disabled + - not_set + default: disabled + secret_scanning_push_protection: + type: string + description: The enablement status of secret scanning push protection + enum: + - enabled + - disabled + - not_set + default: disabled + secret_scanning_validity_checks: + type: string + description: The enablement status of secret scanning validity checks + enum: + - enabled + - disabled + - not_set + default: disabled + secret_scanning_non_provider_patterns: + type: string + description: The enablement status of secret scanning non provider + patterns + enum: + - enabled + - disabled + - not_set + default: disabled + private_vulnerability_reporting: + type: string + description: The enablement status of private vulnerability reporting + enum: + - enabled + - disabled + - not_set + default: disabled + enforcement: + type: string + description: The enforcement status for a security configuration + enum: + - enforced + - unenforced + default: enforced + required: + - name + - description + examples: + default: + summary: Example for a code security configuration + value: + name: High rish settings + description: This is a code security configuration for octo-enterprise + advanced_security: enabled + dependabot_alerts: enabled + dependabot_security_updates: not_set + secret_scanning: enabled + responses: + '201': + description: Successfully created code security configuration + content: + application/json: + schema: + "$ref": "#/components/schemas/code-security-configuration" + examples: + default: + "$ref": "#/components/examples/enterprise-code-security-configuration" + '400': + "$ref": "#/components/responses/bad_request" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: code-security + subcategory: configurations + "/enterprises/{enterprise}/code-security/configurations/defaults": + get: + summary: Get default code security configurations for an enterprise + description: |- + Lists the default code security configurations for an enterprise. + + The authenticated user must be an administrator of the enterprise in order to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. + tags: + - code-security + operationId: code-security/get-default-configurations-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/code-security/configurations#get-default-code-security-configurations-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/code-security-default-configurations" + examples: + default: + "$ref": "#/components/examples/code-security-default-configurations" x-github: githubCloudOnly: false enabledForGitHubApps: true - category: copilot - subcategory: copilot-user-management - "/enterprises/{enterprise}/copilot/metrics": + category: code-security + subcategory: configurations + "/enterprises/{enterprise}/code-security/configurations/{configuration_id}": get: - summary: Get Copilot metrics for an enterprise + summary: Retrieve a code security configuration of an enterprise description: |- - Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. + Gets a code security configuration available in an enterprise. - The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, - and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, - they must have telemetry enabled in their IDE. + The authenticated user must be an administrator of the enterprise in order to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. + tags: + - code-security + operationId: code-security/get-single-configuration-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/code-security/configurations#retrieve-a-code-security-configuration-of-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/configuration-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/code-security-configuration" + examples: + default: + "$ref": "#/components/examples/enterprise-code-security-configuration" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: code-security + subcategory: configurations + patch: + summary: Update a custom code security configuration for an enterprise + description: |- + Updates a code security configuration in an enterprise. - To access this endpoint, the Copilot Metrics API access policy must be enabled or set to "no policy" for the enterprise within GitHub settings. - Only enterprise owners and billing managers can view Copilot metrics for the enterprise. + The authenticated user must be an administrator of the enterprise in order to use this endpoint. - OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. tags: - - copilot - operationId: copilot/copilot-metrics-for-enterprise + - code-security + operationId: code-security/update-enterprise-configuration externalDocs: description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-enterprise + url: https://docs.github.com/rest/code-security/configurations#update-a-custom-code-security-configuration-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" - - name: since - description: Show usage metrics since this date. This is a timestamp in [ISO - 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). - Maximum value is 28 days ago. - in: query - required: false - schema: - type: string - - name: until - description: Show usage metrics until this date. This is a timestamp in [ISO - 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) - and should not preceed the `since` date if it is passed. - in: query - required: false - schema: - type: string - - "$ref": "#/components/parameters/page" - - name: per_page - description: The number of days of metrics to display per page (max 28). For - more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." - in: query - schema: - type: integer - default: 28 + - "$ref": "#/components/parameters/configuration-id" + requestBody: + required: true + content: + application/json: + schema: + type: object + additionalProperties: false + properties: + name: + type: string + description: The name of the code security configuration. Must be + unique across the enterprise. + description: + type: string + description: A description of the code security configuration + maxLength: 255 + advanced_security: + type: string + description: The enablement status of GitHub Advanced Security. + Must be set to enabled if you want to enable any GHAS settings. + enum: + - enabled + - disabled + dependency_graph: + type: string + description: The enablement status of Dependency Graph + enum: + - enabled + - disabled + - not_set + dependency_graph_autosubmit_action: + type: string + description: The enablement status of Automatic dependency submission + enum: + - enabled + - disabled + - not_set + dependency_graph_autosubmit_action_options: + type: object + description: Feature options for Automatic dependency submission + properties: + labeled_runners: + type: boolean + description: Whether to use runners labeled with 'dependency-submission' + or standard GitHub runners. + dependabot_alerts: + type: string + description: The enablement status of Dependabot alerts + enum: + - enabled + - disabled + - not_set + dependabot_security_updates: + type: string + description: The enablement status of Dependabot security updates + enum: + - enabled + - disabled + - not_set + code_scanning_default_setup: + type: string + description: The enablement status of code scanning default setup + enum: + - enabled + - disabled + - not_set + code_scanning_default_setup_options: + "$ref": "#/components/schemas/code-scanning-default-setup-options" + secret_scanning: + type: string + description: The enablement status of secret scanning + enum: + - enabled + - disabled + - not_set + secret_scanning_push_protection: + type: string + description: The enablement status of secret scanning push protection + enum: + - enabled + - disabled + - not_set + secret_scanning_validity_checks: + type: string + description: The enablement status of secret scanning validity checks + enum: + - enabled + - disabled + - not_set + secret_scanning_non_provider_patterns: + type: string + description: The enablement status of secret scanning non-provider + patterns + enum: + - enabled + - disabled + - not_set + private_vulnerability_reporting: + type: string + description: The enablement status of private vulnerability reporting + enum: + - enabled + - disabled + - not_set + enforcement: + type: string + description: The enforcement status for a security configuration + enum: + - enforced + - unenforced + examples: + default: + summary: Example for updating a code security configuration + value: + name: octo-enterprise recommended settings v2 + secret_scanning: disabled + code_scanning_default_setup: enabled responses: '200': description: Response content: application/json: schema: - type: array - items: - "$ref": "#/components/schemas/copilot-usage-metrics-day" + "$ref": "#/components/schemas/code-security-configuration" examples: default: - "$ref": "#/components/examples/copilot-usage-metrics-for-day" - '500': - "$ref": "#/components/responses/internal_error" + "$ref": "#/components/examples/enterprise-code-security-configuration" + '304': + "$ref": "#/components/responses/not_modified" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" - '422': - "$ref": "#/components/responses/usage_metrics_api_disabled" + '409': + "$ref": "#/components/responses/conflict" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: code-security + subcategory: configurations + delete: + summary: Delete a code security configuration for an enterprise + description: |- + Deletes a code security configuration from an enterprise. + Repositories attached to the configuration will retain their settings but will no longer be associated with + the configuration. + + The authenticated user must be an administrator for the enterprise to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + tags: + - code-security + operationId: code-security/delete-configuration-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/code-security/configurations#delete-a-code-security-configuration-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/configuration-id" + responses: + '204': + "$ref": "#/components/responses/no_content" + '400': + "$ref": "#/components/responses/bad_request" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '409': + "$ref": "#/components/responses/conflict" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: code-security + subcategory: configurations + "/enterprises/{enterprise}/code-security/configurations/{configuration_id}/attach": + post: + summary: Attach an enterprise configuration to repositories + description: |- + Attaches an enterprise code security configuration to repositories. If the repositories specified are already attached to a configuration, they will be re-attached to the provided configuration. + + If insufficient GHAS licenses are available to attach the configuration to a repository, only free features will be enabled. + + The authenticated user must be an administrator for the enterprise to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + tags: + - code-security + operationId: code-security/attach-enterprise-configuration + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/code-security/configurations#attach-an-enterprise-configuration-to-repositories + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/configuration-id" + requestBody: + required: true + content: + application/json: + schema: + type: object + additionalProperties: false + properties: + scope: + type: string + description: The type of repositories to attach the configuration + to. `selected` means the configuration will be attached to only + the repositories specified by `selected_repository_ids` + enum: + - all + - all_without_configurations + required: + - scope + examples: + default: + summary: Example for attaching a configuration to some repositories + value: + scope: all + responses: + '202': + "$ref": "#/components/responses/accepted" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '409': + "$ref": "#/components/responses/conflict" x-github: githubCloudOnly: false enabledForGitHubApps: true - category: copilot - subcategory: copilot-metrics - "/enterprises/{enterprise}/copilot/usage": - get: - summary: Get a summary of Copilot usage for enterprise members + category: code-security + subcategory: configurations + "/enterprises/{enterprise}/code-security/configurations/{configuration_id}/defaults": + put: + summary: Set a code security configuration as a default for an enterprise description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. + Sets a code security configuration as a default to be applied to new repositories in your enterprise. - You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE - for all users across organizations with access to Copilot within your enterprise, with a further breakdown of suggestions, acceptances, - and number of active users by editor and language for each day. See the response schema tab for detailed metrics definitions. + This configuration will be applied by default to the matching repository type when created, but only for organizations within the enterprise that do not already have a default code security configuration set. - The response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day, - and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, - they must have telemetry enabled in their IDE. + The authenticated user must be an administrator for the enterprise to use this endpoint. - The time zone in the response is in UTC time, that means that the cutoff time for the "day" is UTC time. + OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + tags: + - code-security + operationId: code-security/set-configuration-as-default-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/configuration-id" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + default_for_new_repos: + type: string + description: Specify which types of repository this security configuration + should be applied to by default. + enum: + - all + - none + - private_and_internal + - public + examples: + default: + summary: Set this configuration to be enabled by default on all new + repositories. + value: + default_for_new_repos: all + responses: + '200': + description: Default successfully changed. + content: + application/json: + schema: + type: object + properties: + default_for_new_repos: + type: string + description: Specifies which types of repository this security + configuration is applied to by default. + enum: + - all + - none + - private_and_internal + - public + configuration: + "$ref": "#/components/schemas/code-security-configuration" + examples: + default: + value: + default_for_new_repos: all + configuration: + "$ref": "#/components/examples/code-security-configuration" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: code-security + subcategory: configurations + "/enterprises/{enterprise}/code-security/configurations/{configuration_id}/repositories": + get: + summary: Get repositories associated with an enterprise code security configuration + description: |- + Lists the repositories associated with an enterprise code security configuration in an organization. - Only owners and billing managers can view Copilot usage metrics for the enterprise. + The authenticated user must be an administrator of the enterprise in order to use this endpoint. - OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. tags: - - copilot - operationId: copilot/usage-metrics-for-enterprise + - code-security + operationId: code-security/get-repositories-for-enterprise-configuration externalDocs: description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-usage#get-a-summary-of-copilot-usage-for-enterprise-members + url: https://docs.github.com/rest/code-security/configurations#get-repositories-associated-with-an-enterprise-code-security-configuration parameters: - "$ref": "#/components/parameters/enterprise" - - name: since - description: Show usage metrics since this date. This is a timestamp in [ISO - 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). - Maximum value is 28 days ago. + - "$ref": "#/components/parameters/configuration-id" + - name: per_page + description: The number of results per page (max 100). For more information, + see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." in: query required: false schema: - type: string - - name: until - description: Show usage metrics until this date. This is a timestamp in [ISO - 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) - and should not preceed the `since` date if it is passed. + type: integer + default: 30 + - "$ref": "#/components/parameters/pagination-before" + - "$ref": "#/components/parameters/pagination-after" + - name: status + description: |- + A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned. + + Can be: `all`, `attached`, `attaching`, `removed`, `enforced`, `failed`, `updating`, `removed_by_enterprise` in: query required: false schema: type: string - - "$ref": "#/components/parameters/page" - - name: per_page - description: The number of days of metrics to display per page (max 28). For - more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." - in: query - schema: - type: integer - default: 28 + default: all responses: '200': description: Response @@ -1637,23 +2095,23 @@ paths: schema: type: array items: - "$ref": "#/components/schemas/copilot-usage-metrics" + "$ref": "#/components/schemas/code-security-configuration-repositories" examples: default: - "$ref": "#/components/examples/copilot-usage-metrics-enterprise" - '500': - "$ref": "#/components/responses/internal_error" - '401': - "$ref": "#/components/responses/requires_authentication" + summary: Example of code security configuration repositories + value: + - status: attached + repository: + "$ref": "#/components/examples/simple-repository" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false - enabledForGitHubApps: true - category: copilot - subcategory: copilot-usage + enabledForGitHubApps: false + category: code-security + subcategory: configurations "/enterprises/{enterprise}/dependabot/alerts": get: summary: List Dependabot alerts for an enterprise @@ -1765,160 +2223,6 @@ paths: enabledForGitHubApps: false category: secret-scanning subcategory: secret-scanning - "/enterprises/{enterprise}/team/{team_slug}/copilot/metrics": - get: - summary: Get Copilot metrics for an enterprise team - description: |- - Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. - - The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, - and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, - they must have telemetry enabled in their IDE. - - > [!NOTE] - > This endpoint will only return results for a given day if the enterprise team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day. - - To access this endpoint, the Copilot Metrics API access policy must be enabled or set to "no policy" for the enterprise within GitHub settings. - Only owners and billing managers for the enterprise that contains the enterprise team can view Copilot metrics for the enterprise team. - - OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. - tags: - - copilot - operationId: copilot/copilot-metrics-for-enterprise-team - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-enterprise-team - parameters: - - "$ref": "#/components/parameters/enterprise" - - "$ref": "#/components/parameters/enterprise-team-slug" - - name: since - description: Show usage metrics since this date. This is a timestamp in [ISO - 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). - Maximum value is 28 days ago. - in: query - required: false - schema: - type: string - - name: until - description: Show usage metrics until this date. This is a timestamp in [ISO - 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) - and should not preceed the `since` date if it is passed. - in: query - required: false - schema: - type: string - - "$ref": "#/components/parameters/page" - - name: per_page - description: The number of days of metrics to display per page (max 28). For - more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." - in: query - schema: - type: integer - default: 28 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - "$ref": "#/components/schemas/copilot-usage-metrics-day" - examples: - default: - "$ref": "#/components/examples/copilot-usage-metrics-for-day" - '500': - "$ref": "#/components/responses/internal_error" - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - '422': - "$ref": "#/components/responses/usage_metrics_api_disabled" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: copilot - subcategory: copilot-metrics - "/enterprises/{enterprise}/team/{team_slug}/copilot/usage": - get: - summary: Get a summary of Copilot usage for an enterprise team - description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE - for users within an enterprise team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day. - See the response schema tab for detailed metrics definitions. - - The response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day, - and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, - they must have telemetry enabled in their IDE. - - > [!NOTE] - > This endpoint will only return results for a given day if the enterprise team had five or more members with active Copilot licenses, as evaluated at the end of that day. - - Owners and billing managers for the enterprise that contains the enterprise team can view Copilot usage metrics for the enterprise team. - - OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. - tags: - - copilot - operationId: copilot/usage-metrics-for-enterprise-team - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-usage#get-a-summary-of-copilot-usage-for-an-enterprise-team - parameters: - - "$ref": "#/components/parameters/enterprise" - - "$ref": "#/components/parameters/team-slug" - - name: since - description: Show usage metrics since this date. This is a timestamp in [ISO - 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). - Maximum value is 28 days ago. - in: query - required: false - schema: - type: string - - name: until - description: Show usage metrics until this date. This is a timestamp in [ISO - 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) - and should not preceed the `since` date if it is passed. - in: query - required: false - schema: - type: string - - "$ref": "#/components/parameters/page" - - name: per_page - description: The number of days of metrics to display per page (max 28). For - more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." - in: query - schema: - type: integer - default: 28 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - "$ref": "#/components/schemas/copilot-usage-metrics" - examples: - default: - "$ref": "#/components/examples/copilot-usage-metrics-org" - '500': - "$ref": "#/components/responses/internal_error" - '401': - "$ref": "#/components/responses/requires_authentication" - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: copilot - subcategory: copilot-usage "/events": get: summary: List public events @@ -4036,6 +4340,41 @@ paths: enabledForGitHubApps: true category: orgs subcategory: orgs + "/organizations/{org}/settings/billing/usage": + get: + summary: Get billing usage report for an organization + description: |- + Gets a report of the total usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account. + + **Note:** This endpoint is only available to organizations with access to the enhanced billing platform. For more information, see "[About the enhanced billing platform](https://docs.github.com/billing/using-the-new-billing-platform)." + tags: + - billing + operationId: billing/get-github-billing-usage-report-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/billing/enhanced-billing#get-billing-usage-report-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/billing-usage-report-year" + - "$ref": "#/components/parameters/billing-usage-report-month" + - "$ref": "#/components/parameters/billing-usage-report-day" + - "$ref": "#/components/parameters/billing-usage-report-hour" + responses: + '200': + "$ref": "#/components/responses/billing_usage_report_org" + '400': + "$ref": "#/components/responses/bad_request" + '403': + "$ref": "#/components/responses/forbidden" + '500': + "$ref": "#/components/responses/internal_error" + '503': + "$ref": "#/components/responses/service_unavailable" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: billing + subcategory: enhanced-billing "/orgs/{org}": get: summary: Get an organization @@ -6726,6 +7065,8 @@ paths: Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information. repository_id: type: integer + bundle_url: + type: string examples: default: "$ref": "#/components/examples/list-attestations" @@ -7055,6 +7396,8 @@ paths: - disabled - not_set default: disabled + code_scanning_default_setup_options: + "$ref": "#/components/schemas/code-scanning-default-setup-options" secret_scanning: type: string description: The enablement status of secret scanning @@ -7378,6 +7721,8 @@ paths: - enabled - disabled - not_set + code_scanning_default_setup_options: + "$ref": "#/components/schemas/code-scanning-default-setup-options" secret_scanning: type: string description: The enablement status of secret scanning @@ -8463,13 +8808,11 @@ paths: Purchases a GitHub Copilot seat for all users within each specified team. The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." - Only organization owners can add Copilot seats for their organization members. - - In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy. + Only organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy. For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." - The response will contain the total number of new seats that were created and existing seats that were refreshed. + The response contains the total number of new seats that were created and existing seats that were refreshed. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: @@ -8547,14 +8890,11 @@ paths: Sets seats for all members of each team specified to "pending cancellation". This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team. - - For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." - - For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." + For more information about disabling access to Copilot, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." Only organization owners can cancel Copilot seats for their organization members. - The response will contain the total number of seats set to "pending cancellation". + The response contains the total number of seats set to "pending cancellation". OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: @@ -8634,13 +8974,11 @@ paths: Purchases a GitHub Copilot seat for each user specified. The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." - Only organization owners can add Copilot seats for their organization members. - - In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy. + Only organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy. For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." - The response will contain the total number of new seats that were created and existing seats that were refreshed. + The response contains the total number of new seats that were created and existing seats that were refreshed. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: @@ -8717,14 +9055,11 @@ paths: Sets seats for all users specified to "pending cancellation". This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership. - - For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." - - For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." + For more information about disabling access to Copilot, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." Only organization owners can cancel Copilot seats for their organization members. - The response will contain the total number of seats set to "pending cancellation". + The response contains the total number of seats set to "pending cancellation". OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: @@ -9483,7 +9818,9 @@ paths: get: summary: List organization webhooks description: |- - You must be an organization owner to use this endpoint. + List webhooks for an organization. + + The authenticated user must be an organization owner to use this endpoint. OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. @@ -9745,7 +10082,9 @@ paths: delete: summary: Delete an organization webhook description: |- - You must be an organization owner to use this endpoint. + Delete a webhook for an organization. + + The authenticated user must be an organization owner to use this endpoint. OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. @@ -10022,6 +10361,7 @@ paths: - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/direction" - "$ref": "#/components/parameters/api-insights-route-stats-sort" + - "$ref": "#/components/parameters/api-insights-api-route-substring" responses: '200': description: Response @@ -10055,6 +10395,7 @@ paths: - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/direction" - "$ref": "#/components/parameters/api-insights-sort" + - "$ref": "#/components/parameters/api-insights-subject-name-substring" responses: '200': description: Response @@ -10273,6 +10614,7 @@ paths: - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/direction" - "$ref": "#/components/parameters/api-insights-sort" + - "$ref": "#/components/parameters/api-insights-actor-name-substring" responses: '200': description: Response @@ -12798,6 +13140,381 @@ paths: enabledForGitHubApps: true category: orgs subcategory: personal-access-tokens + "/orgs/{org}/private-registries": + get: + summary: List private registries for an organization + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Lists all private registry configurations available at the organization-level without revealing their encrypted + values. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - private-registries + operationId: private-registries/list-org-private-registries + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/private-registries/organization-configurations#list-private-registries-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - configurations + properties: + total_count: + type: integer + configurations: + type: array + items: + "$ref": "#/components/schemas/org-private-registry-configuration" + examples: + default: + "$ref": "#/components/examples/org-private-registry-configurations-paginated" + headers: + Link: + "$ref": "#/components/headers/link" + '400': + "$ref": "#/components/responses/bad_request" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: private-registries + subcategory: organization-configurations + post: + summary: Create a private registry for an organization + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Creates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - private-registries + operationId: private-registries/create-org-private-registry + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/private-registries/organization-configurations#create-a-private-registry-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + registry_type: + description: The registry type. + type: string + enum: + - maven_repository + username: + description: The username to use when authenticating with the private + registry. This field should be omitted if the private registry + does not require a username for authentication. + type: + - string + - 'null' + encrypted_value: + description: The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) + using the public key retrieved from the [Get private registries + public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) + endpoint. + type: string + pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" + key_id: + description: The ID of the key you used to encrypt the secret. + type: string + visibility: + description: Which type of organization repositories have access + to the private registry. `selected` means only the repositories + specified by `selected_repository_ids` can access the private + registry. + type: string + enum: + - all + - private + - selected + selected_repository_ids: + description: An array of repository IDs that can access the organization + private registry. You can only provide a list of repository IDs + when `visibility` is set to `selected`. You can manage the list + of selected repositories using the [Update a private registry + for an organization](https://docs.github.com/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization) + endpoint. This field should be omitted if `visibility` is set + to `all` or `private`. + type: array + items: + type: integer + required: + - registry_type + - encrypted_value + - key_id + - visibility + examples: + org-private-registry-with-private-visibility: + summary: Example of a private registry configuration with private + visibility + value: + registry_type: maven_repository + username: monalisa + encrypted_value: c2VjcmV0 + key_id: '012345678912345678' + visibility: private + org-private-registry-with-selected-visibility: + summary: Example of a private registry configuration with selected + visibility + value: + registry_type: maven_repository + username: monalisa + encrypted_value: c2VjcmV0 + key_id: '012345678912345678' + visibility: selected + selected_repository_ids: + - 1296269 + - 1296280 + responses: + '201': + description: The organization private registry configuration + content: + application/json: + schema: + "$ref": "#/components/schemas/org-private-registry-configuration-with-selected-repositories" + examples: + org-private-registry-with-selected-visibility: + "$ref": "#/components/examples/org-private-registry-configuration" + org-private-registry-with-private-visibility: + "$ref": "#/components/examples/org-private-registry-configuration-with-selected-repositories" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: private-registries + subcategory: organization-configurations + "/orgs/{org}/private-registries/public-key": + get: + summary: Get private registries public key for an organization + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Gets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets. + + OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - private-registries + operationId: private-registries/get-org-public-key + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - key_id + - key + properties: + key_id: + description: The identifier for the key. + type: string + examples: + - '012345678912345678' + key: + description: The Base64 encoded public key. + type: string + examples: + - 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 + examples: + default: + "$ref": "#/components/examples/private-registries-public-key" + headers: + Link: + "$ref": "#/components/headers/link" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: private-registries + subcategory: organization-configurations + "/orgs/{org}/private-registries/{secret_name}": + get: + summary: Get a private registry for an organization + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Get the configuration of a single private registry defined for an organization, omitting its encrypted value. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - private-registries + operationId: private-registries/get-org-private-registry + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/private-registries/organization-configurations#get-a-private-registry-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/secret-name" + responses: + '200': + description: The specified private registry configuration for the organization + content: + application/json: + schema: + "$ref": "#/components/schemas/org-private-registry-configuration" + examples: + default: + "$ref": "#/components/examples/org-private-registry-configuration" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: private-registries + subcategory: organization-configurations + patch: + summary: Update a private registry for an organization + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - private-registries + operationId: private-registries/update-org-private-registry + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/secret-name" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + registry_type: + description: The registry type. + type: string + enum: + - maven_repository + username: + description: The username to use when authenticating with the private + registry. This field should be omitted if the private registry + does not require a username for authentication. + type: + - string + - 'null' + encrypted_value: + description: The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) + using the public key retrieved from the [Get private registries + public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) + endpoint. + type: string + pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" + key_id: + description: The ID of the key you used to encrypt the secret. + type: string + visibility: + description: Which type of organization repositories have access + to the private registry. `selected` means only the repositories + specified by `selected_repository_ids` can access the private + registry. + type: string + enum: + - all + - private + - selected + selected_repository_ids: + description: An array of repository IDs that can access the organization + private registry. You can only provide a list of repository IDs + when `visibility` is set to `selected`. This field should be omitted + if `visibility` is set to `all` or `private`. + type: array + items: + type: integer + examples: + update-username-and-encrypted-value: + value: + username: monalisa + encrypted_value: c2VjcmV0 + key_id: '012345678912345678' + update-with-selected-visibility: + value: + visibility: selected + selected_repository_ids: + - 1296269 + - 1296280 + responses: + '204': + description: Response + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: private-registries + subcategory: organization-configurations + delete: + summary: Delete a private registry for an organization + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Delete a private registry configuration at the organization-level. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - private-registries + operationId: private-registries/delete-org-private-registry + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/private-registries/organization-configurations#delete-a-private-registry-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/secret-name" + responses: + '204': + description: Response + '400': + "$ref": "#/components/responses/bad_request" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: private-registries + subcategory: organization-configurations "/orgs/{org}/projects": get: summary: List organization projects @@ -13069,50 +13786,7 @@ paths: content: application/json: schema: - type: object - properties: - value_type: - type: string - enum: - - string - - single_select - - multi_select - - true_false - description: The type of the value for the property - examples: - - single_select - required: - type: boolean - description: Whether the property is required. - default_value: - oneOf: - - type: string - - type: array - items: - type: string - description: Default value of the property - type: - - 'null' - - string - - array - description: - type: - - string - - 'null' - description: Short description of the property - allowed_values: - type: - - array - - 'null' - items: - type: string - maxLength: 75 - maxItems: 200 - description: |- - An ordered list of the allowed values of the property. - The property can have up to 200 allowed values. - required: - - value_type + "$ref": "#/components/schemas/custom-property-set-payload" examples: default: value: @@ -13748,6 +14422,7 @@ paths: - branch - tag - push + - repository default: branch enforcement: "$ref": "#/components/schemas/repository-rule-enforcement" @@ -13964,6 +14639,7 @@ paths: - branch - tag - push + - repository enforcement: "$ref": "#/components/schemas/repository-rule-enforcement" bypass_actors: @@ -14181,11 +14857,8 @@ paths: get: summary: List security manager teams description: |- - Lists teams that are security managers for an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." - - The authenticated user must be an administrator or security manager for the organization to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the "[Organization Roles](https://docs.github.com/rest/orgs/organization-roles)" endpoints instead. tags: - orgs operationId: orgs/list-security-manager-teams @@ -14212,15 +14885,15 @@ paths: previews: [] category: orgs subcategory: security-managers + deprecationDate: '2024-12-01' + removalDate: '2026-01-01' + deprecated: true "/orgs/{org}/security-managers/teams/{team_slug}": put: summary: Add a security manager team description: |- - Adds a team as a security manager for an organization. For more information, see "[Managing security for an organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) for an organization." - - The authenticated user must be an administrator for the organization to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the "[Organization Roles](https://docs.github.com/rest/orgs/organization-roles)" endpoints instead. tags: - orgs operationId: orgs/add-security-manager-team @@ -14239,14 +14912,14 @@ paths: previews: [] category: orgs subcategory: security-managers + deprecationDate: '2024-12-01' + removalDate: '2026-01-01' + deprecated: true delete: summary: Remove a security manager team description: |- - Removes the security manager role from a team for an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) team from an organization." - - The authenticated user must be an administrator for the organization to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the "[Organization Roles](https://docs.github.com/rest/orgs/organization-roles)" endpoints instead. tags: - orgs operationId: orgs/remove-security-manager-team @@ -14265,6 +14938,9 @@ paths: previews: [] category: orgs subcategory: security-managers + deprecationDate: '2024-12-01' + removalDate: '2026-01-01' + deprecated: true "/orgs/{org}/settings/billing/actions": get: summary: Get GitHub Actions billing for an organization @@ -19025,7 +19701,7 @@ paths: OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - This API will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`. + This endpoint will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`. tags: - actions operationId: actions/list-workflow-runs-for-repo @@ -20458,6 +21134,8 @@ paths: Anyone with read access to the repository can use this endpoint OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + + This endpoint will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`. tags: - actions operationId: actions/list-workflow-runs @@ -20840,6 +21518,8 @@ paths: Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information. repository_id: type: integer + bundle_url: + type: string examples: default: "$ref": "#/components/examples/list-attestations" @@ -24193,6 +24873,153 @@ paths: githubCloudOnly: false category: code-scanning subcategory: code-scanning + "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/autofix": + get: + summary: Get the status of an autofix for a code scanning alert + description: |- + Gets the status and description of an autofix for a code scanning alert. + + OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + tags: + - code-scanning + operationId: code-scanning/get-autofix + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/alert-number" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/code-scanning-autofix" + examples: + default: + "$ref": "#/components/examples/code-scanning-autofix" + '400': + "$ref": "#/components/responses/code_scanning_bad_request" + '403': + "$ref": "#/components/responses/code_scanning_forbidden_read" + '404': + "$ref": "#/components/responses/not_found" + '503': + "$ref": "#/components/responses/service_unavailable" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: code-scanning + subcategory: code-scanning + post: + summary: Create an autofix for a code scanning alert + description: |- + Creates an autofix for a code scanning alert. + + If a new autofix is to be created as a result of this request or is currently being generated, then this endpoint will return a 202 Accepted response. + + If an autofix already exists for a given alert, then this endpoint will return a 200 OK response. + + OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + tags: + - code-scanning + operationId: code-scanning/create-autofix + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/code-scanning/code-scanning#create-an-autofix-for-a-code-scanning-alert + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/alert-number" + responses: + '200': + description: OK + content: + application/json: + schema: + "$ref": "#/components/schemas/code-scanning-autofix" + examples: + default: + "$ref": "#/components/examples/code-scanning-autofix" + '202': + description: Accepted + content: + application/json: + schema: + "$ref": "#/components/schemas/code-scanning-autofix" + examples: + default: + "$ref": "#/components/examples/code-scanning-autofix-pending" + '400': + "$ref": "#/components/responses/code_scanning_bad_request" + '403': + "$ref": "#/components/responses/code_scanning_autofix_create_forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + description: Unprocessable Entity + '503': + "$ref": "#/components/responses/service_unavailable" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: code-scanning + subcategory: code-scanning + "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/autofix/commits": + post: + summary: Commit an autofix for a code scanning alert + description: |- + Commits an autofix for a code scanning alert. + + If an autofix is commited as a result of this request, then this endpoint will return a 201 Created response. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + tags: + - code-scanning + operationId: code-scanning/commit-autofix + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/code-scanning/code-scanning#commit-an-autofix-for-a-code-scanning-alert + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/alert-number" + requestBody: + required: false + content: + application/json: + schema: + "$ref": "#/components/schemas/code-scanning-autofix-commits" + examples: + default: + "$ref": "#/components/examples/code-scanning-autofix-commits" + responses: + '201': + description: Created + content: + application/json: + schema: + "$ref": "#/components/schemas/code-scanning-autofix-commits-response" + examples: + default: + "$ref": "#/components/examples/code-scanning-autofix-commits-response" + '400': + "$ref": "#/components/responses/code_scanning_bad_request" + '403': + "$ref": "#/components/responses/code_scanning_forbidden_write" + '404': + "$ref": "#/components/responses/not_found" + '422': + description: Unprocessable Entity + '503': + "$ref": "#/components/responses/service_unavailable" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: code-scanning + subcategory: code-scanning "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances": get: summary: List instances of a code scanning alert @@ -26414,6 +27241,7 @@ paths: | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | | `signature` | `string` | The signature that was extracted from the commit. | | `payload` | `string` | The value that was signed. | + | `verified_at` | `string` | The date the signature was verified by GitHub. | These are the possible values for `reason` in the `verification` object: @@ -26742,6 +27570,7 @@ paths: | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | | `signature` | `string` | The signature that was extracted from the commit. | | `payload` | `string` | The value that was signed. | + | `verified_at` | `string` | The date the signature was verified by GitHub. | These are the possible values for `reason` in the `verification` object: @@ -27082,6 +27911,7 @@ paths: | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | | `signature` | `string` | The signature that was extracted from the commit. | | `payload` | `string` | The value that was signed. | + | `verified_at` | `string` | The date the signature was verified by GitHub. | These are the possible values for `reason` in the `verification` object: @@ -29951,6 +30781,7 @@ paths: | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. | | `signature` | `string` | The signature that was extracted from the commit. | | `payload` | `string` | The value that was signed. | + | `verified_at` | `string` | The date the signature was verified by GitHub. | These are the possible values for `reason` in the `verification` object: @@ -30125,6 +30956,7 @@ paths: | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. | | `signature` | `string` | The signature that was extracted from the commit. | | `payload` | `string` | The value that was signed. | + | `verified_at` | `string` | The date the signature was verified by GitHub. | These are the possible values for `reason` in the `verification` object: @@ -30414,6 +31246,7 @@ paths: | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | | `signature` | `string` | The signature that was extracted from the commit. | | `payload` | `string` | The value that was signed. | + | `verified_at` | `string` | The date the signature was verified by GitHub. | These are the possible values for `reason` in the `verification` object: @@ -30540,6 +31373,7 @@ paths: | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | | `signature` | `string` | The signature that was extracted from the commit. | | `payload` | `string` | The value that was signed. | + | `verified_at` | `string` | The date the signature was verified by GitHub. | These are the possible values for `reason` in the `verification` object: @@ -31002,7 +31836,10 @@ paths: subcategory: webhooks delete: summary: Delete a repository webhook - description: '' + description: |- + Delete a webhook for an organization. + + The authenticated user must be a repository owner, or have admin access in the repository, to delete the webhook. tags: - repos operationId: repos/delete-webhook @@ -33662,6 +34499,255 @@ paths: enabledForGitHubApps: true category: reactions subcategory: reactions + "/repos/{owner}/{repo}/issues/{issue_number}/sub_issue": + delete: + summary: Remove sub-issue + description: |- + You can use the REST API to remove a sub-issue from an issue. + Removing content too quickly using this endpoint may result in secondary rate limiting. + For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass a specific media type. + - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - issues + operationId: issues/remove-sub-issue + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/sub-issues#remove-sub-issue + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/issue-number" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + sub_issue_id: + type: integer + description: The sub-issue to remove + required: + - sub_issue_id + examples: + default: + value: + sub_issue_id: 6 + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/issue" + examples: + default: + "$ref": "#/components/examples/issue" + headers: + Location: + example: https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue + schema: + type: string + '400': + "$ref": "#/components/responses/bad_request" + '404': + "$ref": "#/components/responses/not_found" + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: sub-issues + "/repos/{owner}/{repo}/issues/{issue_number}/sub_issues": + get: + summary: List sub-issues + description: |- + You can use the REST API to list the sub-issues on an issue. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - issues + operationId: issues/list-sub-issues + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/sub-issues#list-sub-issues + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/issue-number" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/issue" + examples: + default: + "$ref": "#/components/examples/issue-items" + headers: + Link: + "$ref": "#/components/headers/link" + '404': + "$ref": "#/components/responses/not_found" + '410': + "$ref": "#/components/responses/gone" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: sub-issues + post: + summary: Add sub-issue + description: |- + You can use the REST API to add sub-issues to issues. + + Creating content too quickly using this endpoint may result in secondary rate limiting. + For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - issues + operationId: issues/add-sub-issue + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/sub-issues#add-sub-issue + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/issue-number" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + sub_issue_id: + type: integer + description: The sub-issue to add + replace_parent: + type: boolean + description: Option that, when true, instructs the operation to + replace the sub-issues current parent issue + required: + - sub_issue_id + examples: + default: + value: + sub_issue_id: 1 + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/issue" + examples: + default: + "$ref": "#/components/examples/issue" + headers: + Location: + example: https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1 + schema: + type: string + '403': + "$ref": "#/components/responses/forbidden" + '410': + "$ref": "#/components/responses/gone" + '422': + "$ref": "#/components/responses/validation_failed" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: sub-issues + "/repos/{owner}/{repo}/issues/{issue_number}/sub_issues/priority": + patch: + summary: Reprioritize sub-issue + description: You can use the REST API to reprioritize a sub-issue to a different + position in the parent list. + tags: + - issues + operationId: issues/reprioritize-sub-issue + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/sub-issues#reprioritize-sub-issue + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/issue-number" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + sub_issue_id: + type: integer + description: The id of the sub-issue to reprioritize + after_id: + type: integer + description: The id of the sub-issue to be prioritized after (either + positional argument after OR before should be specified). + before_id: + type: integer + description: The id of the sub-issue to be prioritized before (either + positional argument after OR before should be specified). + required: + - sub_issue_id + examples: + default: + value: + sub_issue_id: 6 + after_id: 5 + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/issue" + examples: + default: + "$ref": "#/components/examples/issue" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed_simple" + '503': + "$ref": "#/components/responses/service_unavailable" + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: sub-issues "/repos/{owner}/{repo}/issues/{issue_number}/timeline": get: summary: List timeline events for an issue @@ -37739,7 +38825,7 @@ paths: - 'true' - 'false' - legacy - default: true + default: 'true' required: - tag_name examples: @@ -37784,10 +38870,12 @@ paths: "/repos/{owner}/{repo}/releases/assets/{asset_id}": get: summary: Get a release asset - description: To download the asset's binary content, set the `Accept` header - of the request to [`application/octet-stream`](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). - The API will either redirect the client to the location, or stream it directly - if possible. API clients should handle both a `200` or `302` response. + description: "To download the asset's binary content:\n\n- If within a browser, + fetch the location specified in the `browser_download_url` key provided in + the response.\n- Alternatively, set the `Accept` header of the request to + \n [`application/octet-stream`](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + \n The API will either redirect the client to the location, or stream it + directly if possible.\n API clients should handle both a `200` or `302` response." tags: - repos operationId: repos/get-release-asset @@ -39119,6 +40207,42 @@ paths: githubCloudOnly: false category: secret-scanning subcategory: secret-scanning + "/repos/{owner}/{repo}/secret-scanning/scan-history": + get: + summary: Get secret scanning scan history for a repository + description: |- + Lists the latest incremental and backfill scans by type for a repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + tags: + - secret-scanning + operationId: secret-scanning/get-scan-history + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/secret-scanning/secret-scanning#get-secret-scanning-scan-history-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + responses: + '404': + description: Repository does not have GitHub Advanced Security or secret + scanning enabled + '503': + "$ref": "#/components/responses/service_unavailable" + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/secret-scanning-scan-history" + examples: + default: + "$ref": "#/components/examples/secret-scanning-scan-history" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: secret-scanning + subcategory: secret-scanning "/repos/{owner}/{repo}/security-advisories": get: summary: List repository security advisories @@ -47604,6 +48728,8 @@ paths: "$ref": "#/components/schemas/sigstore-bundle-0" repository_id: type: integer + bundle_url: + type: string examples: default: value: @@ -50345,6 +51471,7 @@ webhooks: category: webhooks subcategory: custom_property supported-webhook-types: + - business - organization - app custom-property-deleted: @@ -50410,6 +51537,7 @@ webhooks: category: webhooks subcategory: custom_property supported-webhook-types: + - business - organization - app custom-property-updated: @@ -50475,6 +51603,7 @@ webhooks: category: webhooks subcategory: custom_property supported-webhook-types: + - business - organization - app custom-property-values-updated: @@ -63508,6 +64637,73 @@ webhooks: - repository - organization - app + secret-scanning-scan-completed: + post: + summary: |- + This event occurs when secret scanning completes certain scans on a repository. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." + + Scans can originate from multiple events such as updates to a custom pattern, a push to a repository, or updates + to patterns from partners. For more information on custom patterns, see "[About custom patterns](https://docs.github.com/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns)." + + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + description: A secret scanning scan was completed. + operationId: secret-scanning-scan/completed + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_scan + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-secret-scanning-scan-completed" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: secret_scanning_scan + supported-webhook-types: + - repository + - organization + - app security-advisory-published: post: summary: |- @@ -68586,984 +69782,216 @@ components: - html_url - key - name - organization-simple: - title: Organization Simple - description: A GitHub organization. - type: object - properties: - login: - type: string - examples: - - github - id: - type: integer - examples: - - 1 - node_id: - type: string - examples: - - MDEyOk9yZ2FuaXphdGlvbjE= - url: - type: string - format: uri - examples: - - https://api.github.com/orgs/github - repos_url: - type: string - format: uri - examples: - - https://api.github.com/orgs/github/repos - events_url: - type: string - format: uri - examples: - - https://api.github.com/orgs/github/events - hooks_url: - type: string - examples: - - https://api.github.com/orgs/github/hooks - issues_url: - type: string - examples: - - https://api.github.com/orgs/github/issues - members_url: - type: string - examples: - - https://api.github.com/orgs/github/members{/member} - public_members_url: - type: string - examples: - - https://api.github.com/orgs/github/public_members{/member} - avatar_url: - type: string - examples: - - https://github.com/images/error/octocat_happy.gif - description: - type: - - string - - 'null' - examples: - - A great organization - required: - - login - - url - - id - - node_id - - repos_url - - events_url - - hooks_url - - issues_url - - members_url - - public_members_url - - avatar_url - - description - team-simple: - title: Team Simple - description: Groups of organization members that gives permissions on specified - repositories. + code-security-configuration: type: object + description: A code security configuration properties: id: - description: Unique identifier of the team type: integer - examples: - - 1 - node_id: - type: string - examples: - - MDQ6VGVhbTE= - url: - description: URL for the team - type: string - format: uri - examples: - - https://api.github.com/organizations/1/team/1 - members_url: - type: string - examples: - - https://api.github.com/organizations/1/team/1/members{/member} + description: The ID of the code security configuration name: - description: Name of the team - type: string - examples: - - Justice League - description: - description: Description of the team - type: - - string - - 'null' - examples: - - A great team. - permission: - description: Permission that the team will have for its repositories - type: string - examples: - - admin - privacy: - description: The level of privacy this team should have type: string - examples: - - closed - notification_setting: - description: The notification setting the team has set + description: The name of the code security configuration. Must be unique + within the organization. + target_type: type: string - examples: - - notifications_enabled - html_url: + description: The type of the code security configuration. + enum: + - global + - organization + - enterprise + description: type: string - format: uri - examples: - - https://github.com/orgs/rails/teams/core - repositories_url: + description: A description of the code security configuration + advanced_security: type: string - format: uri - examples: - - https://api.github.com/organizations/1/team/1/repos - slug: + description: The enablement status of GitHub Advanced Security + enum: + - enabled + - disabled + dependency_graph: type: string - examples: - - justice-league - ldap_dn: - description: Distinguished Name (DN) that team maps to within LDAP environment + description: The enablement status of Dependency Graph + enum: + - enabled + - disabled + - not_set + dependency_graph_autosubmit_action: type: string - examples: - - uid=example,ou=users,dc=github,dc=com - required: - - id - - node_id - - url - - members_url - - name - - description - - permission - - html_url - - repositories_url - - slug - team: - title: Team - description: Groups of organization members that gives permissions on specified - repositories. - type: object - properties: - id: - type: integer - node_id: + description: The enablement status of Automatic dependency submission + enum: + - enabled + - disabled + - not_set + dependency_graph_autosubmit_action_options: + type: object + description: Feature options for Automatic dependency submission + properties: + labeled_runners: + type: boolean + description: Whether to use runners labeled with 'dependency-submission' + or standard GitHub runners. + dependabot_alerts: type: string - name: + description: The enablement status of Dependabot alerts + enum: + - enabled + - disabled + - not_set + dependabot_security_updates: type: string - slug: + description: The enablement status of Dependabot security updates + enum: + - enabled + - disabled + - not_set + code_scanning_default_setup: type: string - description: + description: The enablement status of code scanning default setup + enum: + - enabled + - disabled + - not_set + code_scanning_default_setup_options: type: - - string + - object - 'null' - privacy: + description: Feature options for code scanning default setup + properties: + runner_type: + type: + - string + - 'null' + enum: + - standard + - labeled + - not_set + - + description: Whether to use labeled runners or standard GitHub runners. + runner_label: + type: + - string + - 'null' + description: The label of the runner to use for code scanning when runner_type + is 'labeled'. + secret_scanning: type: string - notification_setting: + description: The enablement status of secret scanning + enum: + - enabled + - disabled + - not_set + secret_scanning_push_protection: type: string - permission: + description: The enablement status of secret scanning push protection + enum: + - enabled + - disabled + - not_set + secret_scanning_delegated_bypass: type: string - permissions: + description: The enablement status of secret scanning delegated bypass + enum: + - enabled + - disabled + - not_set + secret_scanning_delegated_bypass_options: type: object + description: Feature options for secret scanning delegated bypass properties: - pull: - type: boolean - triage: - type: boolean - push: - type: boolean - maintain: - type: boolean - admin: - type: boolean - required: - - pull - - triage - - push - - maintain - - admin - url: - type: string - format: uri - html_url: - type: string - format: uri - examples: - - https://github.com/orgs/rails/teams/core - members_url: + reviewers: + type: array + description: The bypass reviewers for secret scanning delegated bypass + items: + type: object + required: + - reviewer_id + - reviewer_type + properties: + reviewer_id: + type: integer + description: The ID of the team or role selected as a bypass reviewer + reviewer_type: + type: string + description: The type of the bypass reviewer + enum: + - TEAM + - ROLE + secret_scanning_validity_checks: type: string - repositories_url: + description: The enablement status of secret scanning validity checks + enum: + - enabled + - disabled + - not_set + secret_scanning_non_provider_patterns: type: string - format: uri - parent: - anyOf: - - type: 'null' - - "$ref": "#/components/schemas/team-simple" - required: - - id - - node_id - - url - - members_url - - name - - description - - permission - - html_url - - repositories_url - - slug - - parent - enterprise-team: - title: Enterprise Team - description: Group of enterprise owners and/or members - type: object - properties: - id: - type: integer - format: int64 - name: + description: The enablement status of secret scanning non-provider patterns + enum: + - enabled + - disabled + - not_set + private_vulnerability_reporting: type: string - slug: + description: The enablement status of private vulnerability reporting + enum: + - enabled + - disabled + - not_set + enforcement: type: string + description: The enforcement status for a security configuration + enum: + - enforced + - unenforced url: type: string format: uri - sync_to_organizations: - type: string - examples: - - disabled | all - group_id: - type: - - string - - 'null' - examples: - - 62ab9291-fae2-468e-974b-7e45096d5021 + description: The URL of the configuration html_url: type: string format: uri - examples: - - https://github.com/enterprises/dc/teams/justice-league - members_url: - type: string - created_at: - type: string - format: date-time - updated_at: - type: string - format: date-time - required: - - id - - url - - members_url - - sync_to_organizations - - name - - html_url - - slug - - created_at - - updated_at - copilot-seat-details: - title: Copilot Business Seat Detail - description: Information about a Copilot Business seat assignment for a user, - team, or organization. - type: object - properties: - assignee: - "$ref": "#/components/schemas/simple-user" - organization: - anyOf: - - type: 'null' - - "$ref": "#/components/schemas/organization-simple" - assigning_team: - description: The team through which the assignee is granted access to GitHub - Copilot, if applicable. - oneOf: - - "$ref": "#/components/schemas/team" - - "$ref": "#/components/schemas/enterprise-team" - type: - - 'null' - - object - pending_cancellation_date: - type: - - string - - 'null' - format: date - description: The pending cancellation date for the seat, in `YYYY-MM-DD` - format. This will be null unless the assignee's Copilot access has been - canceled during the current billing cycle. If the seat has been cancelled, - this corresponds to the start of the organization's next billing cycle. - last_activity_at: - type: - - string - - 'null' - format: date-time - description: Timestamp of user's last GitHub Copilot activity, in ISO 8601 - format. - last_activity_editor: - type: - - string - - 'null' - description: Last editor that was used by the user for a GitHub Copilot - completion. + description: The URL of the configuration created_at: type: string format: date-time - description: Timestamp of when the assignee was last granted access to GitHub - Copilot, in ISO 8601 format. updated_at: type: string format: date-time - description: Timestamp of when the assignee's GitHub Copilot access was - last updated, in ISO 8601 format. - plan_type: - type: string - description: The Copilot plan of the organization, or the parent enterprise, - when applicable. - enum: - - business - - enterprise - - unknown - required: - - assignee - - created_at - additionalProperties: false - copilot-ide-code-completions: + code-scanning-default-setup-options: type: - object - 'null' - description: Usage metrics for Copilot editor code completions in the IDE. - additionalProperties: true + description: Feature options for code scanning default setup properties: - total_engaged_users: - type: integer - description: Number of users who accepted at least one Copilot code suggestion, - across all active editors. Includes both full and partial acceptances. - languages: - type: array - description: Code completion metrics for active languages. - items: - type: object - description: Usage metrics for a given language for the given editor for - Copilot code completions. - properties: - name: - type: string - description: Name of the language used for Copilot code completion - suggestions. - total_engaged_users: - type: integer - description: Number of users who accepted at least one Copilot code - completion suggestion for the given language. Includes both full - and partial acceptances. - editors: - type: array - items: - type: object - description: Copilot code completion metrics for active editors. - additionalProperties: true - properties: - name: - type: string - description: Name of the given editor. - total_engaged_users: - type: integer - description: Number of users who accepted at least one Copilot code - completion suggestion for the given editor. Includes both full and - partial acceptances. - models: - type: array - description: List of model metrics for custom models and the default - model. - items: - type: object - properties: - name: - type: string - description: Name of the language used for Copilot code completion - suggestions, for the given editor. - is_custom_model: - type: boolean - description: Indicates whether a model is custom or default. - custom_model_training_date: - type: - - string - - 'null' - description: The training date for the custom model. - total_engaged_users: - type: integer - description: Number of users who accepted at least one Copilot - code completion suggestion for the given editor, for the given - language and model. Includes both full and partial acceptances. - languages: - type: array - description: Code completion metrics for active languages, for - the given editor. - items: - type: object - description: Usage metrics for a given language for the given - editor for Copilot code completions. - properties: - name: - type: string - description: Name of the language used for Copilot code - completion suggestions, for the given editor. - total_engaged_users: - type: integer - description: Number of users who accepted at least one - Copilot code completion suggestion for the given editor, - for the given language. Includes both full and partial - acceptances. - total_code_suggestions: - type: integer - description: The number of Copilot code suggestions generated - for the given editor, for the given language. - total_code_acceptances: - type: integer - description: The number of Copilot code suggestions accepted - for the given editor, for the given language. Includes - both full and partial acceptances. - total_code_lines_suggested: - type: integer - description: The number of lines of code suggested by - Copilot code completions for the given editor, for the - given language. - total_code_lines_accepted: - type: integer - description: The number of lines of code accepted from - Copilot code suggestions for the given editor, for the - given language. - copilot-ide-chat: - type: - - object - - 'null' - description: Usage metrics for Copilot Chat in the IDE. - additionalProperties: true - properties: - total_engaged_users: - type: integer - description: Total number of users who prompted Copilot Chat in the IDE. - editors: - type: array - items: - type: object - description: Copilot Chat metrics, for active editors. - properties: - name: - type: string - description: Name of the given editor. - total_engaged_users: - type: integer - description: The number of users who prompted Copilot Chat in the - specified editor. - models: - type: array - description: List of model metrics for custom models and the default - model. - items: - type: object - properties: - name: - type: string - description: Name of the language used for Copilot code completion - suggestions, for the given editor. - is_custom_model: - type: boolean - description: Indicates whether a model is custom or default. - custom_model_training_date: - type: - - string - - 'null' - description: The training date for the custom model. - total_engaged_users: - type: integer - description: The number of users who prompted Copilot Chat in - the given editor and model. - total_chats: - type: integer - description: The total number of chats initiated by users in - the given editor and model. - total_chat_insertion_events: - type: integer - description: The number of times users accepted a code suggestion - from Copilot Chat using the 'Insert Code' UI element, for - the given editor. - total_chat_copy_events: - type: integer - description: The number of times users copied a code suggestion - from Copilot Chat using the keyboard, or the 'Copy' UI element, - for the given editor. - copilot-dotcom-chat: - type: - - object - - 'null' - description: Usage metrics for Copilot Chat in github.com - additionalProperties: true - properties: - total_engaged_users: - type: integer - description: Total number of users who prompted Copilot Chat on github.com - at least once. - models: - type: array - description: List of model metrics for a custom models and the default model. - items: - type: object - properties: - name: - type: string - description: Name of the language used for Copilot code completion - suggestions, for the given editor. - is_custom_model: - type: boolean - description: Indicates whether a model is custom or default. - custom_model_training_date: - type: - - string - - 'null' - description: The training date for the custom model (if applicable). - total_engaged_users: - type: integer - description: Total number of users who prompted Copilot Chat on github.com - at least once for each model. - total_chats: - type: integer - description: Total number of chats initiated by users on github.com. - copilot-dotcom-pull-requests: - type: - - object - - 'null' - description: Usage metrics for Copilot for pull requests. - additionalProperties: true - properties: - total_engaged_users: - type: integer - description: The number of users who used Copilot for Pull Requests on github.com - to generate a pull request summary at least once. - repositories: - type: array - description: Repositories in which users used Copilot for Pull Requests - to generate pull request summaries - items: - type: object - properties: - name: - type: string - description: Repository name - total_engaged_users: - type: integer - description: The number of users who generated pull request summaries - using Copilot for Pull Requests in the given repository. - models: - type: array - description: List of model metrics for custom models and the default - model. - items: - type: object - properties: - name: - type: string - description: Name of the language used for Copilot code completion - suggestions, for the given editor. - is_custom_model: - type: boolean - description: Indicates whether a model is custom or default. - custom_model_training_date: - type: - - string - - 'null' - description: The training date for the custom model. - total_pr_summaries_created: - type: integer - description: The number of pull request summaries generated - using Copilot for Pull Requests in the given repository. - total_engaged_users: - type: integer - description: The number of users who generated pull request - summaries using Copilot for Pull Requests in the given repository - and model. - copilot-usage-metrics-day: - title: Copilot Usage Metrics - description: Copilot usage metrics for a given day. - type: object - properties: - date: + runner_type: type: string - format: date - description: The date for which the usage metrics are aggregated, in `YYYY-MM-DD` - format. - total_active_users: - type: integer - description: The total number of Copilot users with activity belonging to - any Copilot feature, globally, for the given day. Includes passive activity - such as receiving a code suggestion, as well as engagement activity such - as accepting a code suggestion or prompting chat. Does not include authentication - events. Is not limited to the individual features detailed on the endpoint. - total_engaged_users: - type: integer - description: The total number of Copilot users who engaged with any Copilot - feature, for the given day. Examples include but are not limited to accepting - a code suggestion, prompting Copilot chat, or triggering a PR Summary. - Does not include authentication events. Is not limited to the individual - features detailed on the endpoint. - copilot_ide_code_completions: - "$ref": "#/components/schemas/copilot-ide-code-completions" - copilot_ide_chat: - "$ref": "#/components/schemas/copilot-ide-chat" - copilot_dotcom_chat: - "$ref": "#/components/schemas/copilot-dotcom-chat" - copilot_dotcom_pull_requests: - "$ref": "#/components/schemas/copilot-dotcom-pull-requests" - required: - - date - additionalProperties: true - copilot-usage-metrics: - title: Copilot Usage Metrics - description: Summary of Copilot usage. - type: object - properties: - day: - type: string - format: date - description: The date for which the usage metrics are reported, in `YYYY-MM-DD` - format. - total_suggestions_count: - type: integer - description: The total number of Copilot code completion suggestions shown - to users. - total_acceptances_count: - type: integer - description: The total number of Copilot code completion suggestions accepted - by users. - total_lines_suggested: - type: integer - description: The total number of lines of code completions suggested by - Copilot. - total_lines_accepted: - type: integer - description: The total number of lines of code completions accepted by users. - total_active_users: - type: integer - description: The total number of users who were shown Copilot code completion - suggestions during the day specified. - total_chat_acceptances: - type: integer - description: The total instances of users who accepted code suggested by - Copilot Chat in the IDE (panel and inline). - total_chat_turns: - type: integer - description: The total number of chat turns (prompt and response pairs) - sent between users and Copilot Chat in the IDE. - total_active_chat_users: - type: integer - description: The total number of users who interacted with Copilot Chat - in the IDE during the day specified. - breakdown: - type: - - array - - 'null' - description: Breakdown of Copilot code completions usage by language and - editor - items: - type: object - description: Breakdown of Copilot usage by editor for this language - additionalProperties: true - properties: - language: - type: string - description: The language in which Copilot suggestions were shown - to users in the specified editor. - editor: - type: string - description: The editor in which Copilot suggestions were shown to - users for the specified language. - suggestions_count: - type: integer - description: The number of Copilot suggestions shown to users in the - editor specified during the day specified. - acceptances_count: - type: integer - description: The number of Copilot suggestions accepted by users in - the editor specified during the day specified. - lines_suggested: - type: integer - description: The number of lines of code suggested by Copilot in the - editor specified during the day specified. - lines_accepted: - type: integer - description: The number of lines of code accepted by users in the - editor specified during the day specified. - active_users: - type: integer - description: The number of users who were shown Copilot completion - suggestions in the editor specified during the day specified. - required: - - day - - breakdown - additionalProperties: false - alert-number: - type: integer - description: The security alert number. - readOnly: true - dependabot-alert-package: - type: object - description: Details for the vulnerable package. - readOnly: true - properties: - ecosystem: - type: string - description: The package's language or package management ecosystem. - readOnly: true - name: - type: string - description: The unique package name within its ecosystem. - readOnly: true - required: - - ecosystem - - name - additionalProperties: false - dependabot-alert-security-vulnerability: - type: object - description: Details pertaining to one vulnerable version range for the advisory. - readOnly: true - properties: - package: - "$ref": "#/components/schemas/dependabot-alert-package" - severity: - type: string - description: The severity of the vulnerability. - readOnly: true enum: - - low - - medium - - high - - critical - vulnerable_version_range: - type: string - description: Conditions that identify vulnerable versions of this vulnerability's - package. - readOnly: true - first_patched_version: - type: - - object - - 'null' - description: Details pertaining to the package version that patches this - vulnerability. - readOnly: true - properties: - identifier: - type: string - description: The package version that patches this vulnerability. - readOnly: true - required: - - identifier - additionalProperties: false - required: - - package - - severity - - vulnerable_version_range - - first_patched_version - additionalProperties: false - dependabot-alert-security-advisory: - type: object - description: Details for the GitHub Security Advisory. - readOnly: true - properties: - ghsa_id: - type: string - description: The unique GitHub Security Advisory ID assigned to the advisory. - readOnly: true - cve_id: - type: - - string - - 'null' - description: The unique CVE ID assigned to the advisory. - readOnly: true - summary: - type: string - description: A short, plain text summary of the advisory. - readOnly: true - maxLength: 1024 - description: - type: string - description: A long-form Markdown-supported description of the advisory. - readOnly: true - vulnerabilities: - type: array - description: Vulnerable version range information for the advisory. - readOnly: true - items: - "$ref": "#/components/schemas/dependabot-alert-security-vulnerability" - severity: - type: string - description: The severity of the advisory. - readOnly: true - enum: - - low - - medium - - high - - critical - cvss: - type: object - description: Details for the advisory pertaining to the Common Vulnerability - Scoring System. - readOnly: true - properties: - score: - type: number - description: The overall CVSS score of the advisory. - minimum: 0 - maximum: 10 - readOnly: true - vector_string: - type: - - string - - 'null' - description: The full CVSS vector string for the advisory. - readOnly: true - required: - - score - - vector_string - additionalProperties: false - cvss_severities: - "$ref": "#/components/schemas/cvss-severities" - cwes: - type: array - description: Details for the advisory pertaining to Common Weakness Enumeration. - readOnly: true - items: - type: object - description: A CWE weakness assigned to the advisory. - readOnly: true - properties: - cwe_id: - type: string - description: The unique CWE ID. - readOnly: true - name: - type: string - description: The short, plain text name of the CWE. - readOnly: true - required: - - cwe_id - - name - additionalProperties: false - identifiers: - type: array - description: Values that identify this advisory among security information - sources. - readOnly: true - items: - type: object - description: An advisory identifier. - readOnly: true - properties: - type: - type: string - description: The type of advisory identifier. - readOnly: true - enum: - - CVE - - GHSA - value: - type: string - description: The value of the advisory identifer. - readOnly: true - required: - - value - - type - additionalProperties: false - references: - type: array - description: Links to additional advisory information. - readOnly: true - items: - type: object - description: A link to additional advisory information. - readOnly: true - properties: - url: - type: string - description: The URL of the reference. - format: uri - readOnly: true - required: - - url - additionalProperties: false - published_at: - type: string - description: 'The time that the advisory was published in ISO 8601 format: - `YYYY-MM-DDTHH:MM:SSZ`.' - format: date-time - readOnly: true - updated_at: - type: string - description: 'The time that the advisory was last modified in ISO 8601 format: - `YYYY-MM-DDTHH:MM:SSZ`.' - format: date-time - readOnly: true - withdrawn_at: + - standard + - labeled + - not_set + description: Whether to use labeled runners or standard GitHub runners. + runner_label: type: - string - 'null' - description: 'The time that the advisory was withdrawn in ISO 8601 format: - `YYYY-MM-DDTHH:MM:SSZ`.' - format: date-time - readOnly: true - required: - - ghsa_id - - cve_id - - summary - - description - - vulnerabilities - - severity - - cvss - - cwes - - identifiers - - references - - published_at - - updated_at - - withdrawn_at - additionalProperties: false - alert-url: - type: string - description: The REST API URL of the alert resource. - format: uri - readOnly: true - alert-html-url: - type: string - description: The GitHub URL of the alert resource. - format: uri - readOnly: true - alert-created-at: - type: string - description: 'The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' - format: date-time - readOnly: true - alert-updated-at: - type: string - description: 'The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' - format: date-time - readOnly: true - alert-dismissed-at: - type: - - string - - 'null' - description: 'The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' - format: date-time - readOnly: true - alert-fixed-at: - type: - - string - - 'null' - description: 'The time that the alert was no longer detected and was considered - fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' - format: date-time - readOnly: true - alert-auto-dismissed-at: - type: - - string - - 'null' - description: 'The time that the alert was auto-dismissed in ISO 8601 format: - `YYYY-MM-DDTHH:MM:SSZ`.' - format: date-time - readOnly: true + description: The label of the runner to use for code scanning default setup + when runner_type is 'labeled'. + code-security-default-configurations: + type: array + description: A list of default code security configurations + items: + type: object + properties: + default_for_new_repos: + enum: + - public + - private_and_internal + - all + description: The visibility of newly created repositories for which the + code security configuration will be applied to by default + configuration: + "$ref": "#/components/schemas/code-security-configuration" simple-repository: title: Simple Repository description: A GitHub repository. @@ -69880,6 +70308,293 @@ components: - teams_url - trees_url - url + code-security-configuration-repositories: + type: object + description: Repositories associated with a code security configuration and + attachment status + properties: + status: + type: string + description: The attachment status of the code security configuration on + the repository. + enum: + - attached + - attaching + - detached + - removed + - enforced + - failed + - updating + - removed_by_enterprise + repository: + "$ref": "#/components/schemas/simple-repository" + alert-number: + type: integer + description: The security alert number. + readOnly: true + dependabot-alert-package: + type: object + description: Details for the vulnerable package. + readOnly: true + properties: + ecosystem: + type: string + description: The package's language or package management ecosystem. + readOnly: true + name: + type: string + description: The unique package name within its ecosystem. + readOnly: true + required: + - ecosystem + - name + additionalProperties: false + dependabot-alert-security-vulnerability: + type: object + description: Details pertaining to one vulnerable version range for the advisory. + readOnly: true + properties: + package: + "$ref": "#/components/schemas/dependabot-alert-package" + severity: + type: string + description: The severity of the vulnerability. + readOnly: true + enum: + - low + - medium + - high + - critical + vulnerable_version_range: + type: string + description: Conditions that identify vulnerable versions of this vulnerability's + package. + readOnly: true + first_patched_version: + type: + - object + - 'null' + description: Details pertaining to the package version that patches this + vulnerability. + readOnly: true + properties: + identifier: + type: string + description: The package version that patches this vulnerability. + readOnly: true + required: + - identifier + additionalProperties: false + required: + - package + - severity + - vulnerable_version_range + - first_patched_version + additionalProperties: false + dependabot-alert-security-advisory: + type: object + description: Details for the GitHub Security Advisory. + readOnly: true + properties: + ghsa_id: + type: string + description: The unique GitHub Security Advisory ID assigned to the advisory. + readOnly: true + cve_id: + type: + - string + - 'null' + description: The unique CVE ID assigned to the advisory. + readOnly: true + summary: + type: string + description: A short, plain text summary of the advisory. + readOnly: true + maxLength: 1024 + description: + type: string + description: A long-form Markdown-supported description of the advisory. + readOnly: true + vulnerabilities: + type: array + description: Vulnerable version range information for the advisory. + readOnly: true + items: + "$ref": "#/components/schemas/dependabot-alert-security-vulnerability" + severity: + type: string + description: The severity of the advisory. + readOnly: true + enum: + - low + - medium + - high + - critical + cvss: + type: object + description: Details for the advisory pertaining to the Common Vulnerability + Scoring System. + readOnly: true + properties: + score: + type: number + description: The overall CVSS score of the advisory. + minimum: 0 + maximum: 10 + readOnly: true + vector_string: + type: + - string + - 'null' + description: The full CVSS vector string for the advisory. + readOnly: true + required: + - score + - vector_string + additionalProperties: false + cvss_severities: + "$ref": "#/components/schemas/cvss-severities" + cwes: + type: array + description: Details for the advisory pertaining to Common Weakness Enumeration. + readOnly: true + items: + type: object + description: A CWE weakness assigned to the advisory. + readOnly: true + properties: + cwe_id: + type: string + description: The unique CWE ID. + readOnly: true + name: + type: string + description: The short, plain text name of the CWE. + readOnly: true + required: + - cwe_id + - name + additionalProperties: false + identifiers: + type: array + description: Values that identify this advisory among security information + sources. + readOnly: true + items: + type: object + description: An advisory identifier. + readOnly: true + properties: + type: + type: string + description: The type of advisory identifier. + readOnly: true + enum: + - CVE + - GHSA + value: + type: string + description: The value of the advisory identifer. + readOnly: true + required: + - value + - type + additionalProperties: false + references: + type: array + description: Links to additional advisory information. + readOnly: true + items: + type: object + description: A link to additional advisory information. + readOnly: true + properties: + url: + type: string + description: The URL of the reference. + format: uri + readOnly: true + required: + - url + additionalProperties: false + published_at: + type: string + description: 'The time that the advisory was published in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`.' + format: date-time + readOnly: true + updated_at: + type: string + description: 'The time that the advisory was last modified in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`.' + format: date-time + readOnly: true + withdrawn_at: + type: + - string + - 'null' + description: 'The time that the advisory was withdrawn in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`.' + format: date-time + readOnly: true + required: + - ghsa_id + - cve_id + - summary + - description + - vulnerabilities + - severity + - cvss + - cwes + - identifiers + - references + - published_at + - updated_at + - withdrawn_at + additionalProperties: false + alert-url: + type: string + description: The REST API URL of the alert resource. + format: uri + readOnly: true + alert-html-url: + type: string + description: The GitHub URL of the alert resource. + format: uri + readOnly: true + alert-created-at: + type: string + description: 'The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' + format: date-time + readOnly: true + alert-updated-at: + type: string + description: 'The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' + format: date-time + readOnly: true + alert-dismissed-at: + type: + - string + - 'null' + description: 'The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' + format: date-time + readOnly: true + alert-fixed-at: + type: + - string + - 'null' + description: 'The time that the alert was no longer detected and was considered + fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' + format: date-time + readOnly: true + alert-auto-dismissed-at: + type: + - string + - 'null' + description: 'The time that the alert was auto-dismissed in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`.' + format: date-time + readOnly: true dependabot-alert-with-repository: type: object description: A Dependabot alert. @@ -70057,6 +70772,26 @@ components: format: date-time description: 'The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' + push_protection_bypass_request_reviewer: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + push_protection_bypass_request_reviewer_comment: + type: + - string + - 'null' + description: An optional comment when reviewing a push protection bypass. + push_protection_bypass_request_comment: + type: + - string + - 'null' + description: An optional comment when requesting a push protection bypass. + push_protection_bypass_request_html_url: + type: + - string + - 'null' + format: uri + description: The URL to a push protection bypass request. resolution_comment: type: - string @@ -70264,6 +70999,20 @@ components: - hooray - eyes - rocket + sub-issues-summary: + title: Sub-issues Summary + type: object + properties: + total: + type: integer + completed: + type: integer + percent_completed: + type: integer + required: + - total + - completed + - percent_completed issue: title: Issue description: Issues are a great way to keep track of tasks, enhancements, and @@ -70458,6 +71207,8 @@ components: "$ref": "#/components/schemas/author-association" reactions: "$ref": "#/components/schemas/reaction-rollup" + sub_issues_summary: + "$ref": "#/components/schemas/sub-issues-summary" required: - assignee - closed_at @@ -71717,6 +72468,21 @@ components: type: string examples: - example.com + actions_inbound: + type: object + properties: + full_domains: + type: array + items: + type: string + examples: + - example.com + wildcard_domains: + type: array + items: + type: string + examples: + - example.com artifact_attestations: type: object properties: @@ -72271,6 +73037,129 @@ components: - reason - url - subscribed + organization-simple: + title: Organization Simple + description: A GitHub organization. + type: object + properties: + login: + type: string + examples: + - github + id: + type: integer + examples: + - 1 + node_id: + type: string + examples: + - MDEyOk9yZ2FuaXphdGlvbjE= + url: + type: string + format: uri + examples: + - https://api.github.com/orgs/github + repos_url: + type: string + format: uri + examples: + - https://api.github.com/orgs/github/repos + events_url: + type: string + format: uri + examples: + - https://api.github.com/orgs/github/events + hooks_url: + type: string + examples: + - https://api.github.com/orgs/github/hooks + issues_url: + type: string + examples: + - https://api.github.com/orgs/github/issues + members_url: + type: string + examples: + - https://api.github.com/orgs/github/members{/member} + public_members_url: + type: string + examples: + - https://api.github.com/orgs/github/public_members{/member} + avatar_url: + type: string + examples: + - https://github.com/images/error/octocat_happy.gif + description: + type: + - string + - 'null' + examples: + - A great organization + required: + - login + - url + - id + - node_id + - repos_url + - events_url + - hooks_url + - issues_url + - members_url + - public_members_url + - avatar_url + - description + billing-usage-report: + type: object + properties: + usageItems: + type: array + items: + type: object + properties: + date: + type: string + description: Date of the usage line item. + product: + type: string + description: Product name. + sku: + type: string + description: SKU name. + quantity: + type: integer + description: Quantity of the usage line item. + unitType: + type: string + description: Unit type of the usage line item. + pricePerUnit: + type: number + description: Price per unit of the usage line item. + grossAmount: + type: number + description: Gross amount of the usage line item. + discountAmount: + type: number + description: Discount amount of the usage line item. + netAmount: + type: number + description: Net amount of the usage line item. + organizationName: + type: string + description: Name of the organization. + repositoryName: + type: string + description: Name of the repository. + required: + - date + - product + - sku + - quantity + - unitType + - pricePerUnit + - grossAmount + - discountAmount + - netAmount + - organizationName organization-full: title: Organization Full description: Organization Full @@ -73323,195 +74212,6 @@ components: - tool - most_recent_instance - repository - code-security-configuration: - type: object - description: A code security configuration - properties: - id: - type: integer - description: The ID of the code security configuration - name: - type: string - description: The name of the code security configuration. Must be unique - within the organization. - target_type: - type: string - description: The type of the code security configuration. - enum: - - global - - organization - - enterprise - description: - type: string - description: A description of the code security configuration - advanced_security: - type: string - description: The enablement status of GitHub Advanced Security - enum: - - enabled - - disabled - dependency_graph: - type: string - description: The enablement status of Dependency Graph - enum: - - enabled - - disabled - - not_set - dependency_graph_autosubmit_action: - type: string - description: The enablement status of Automatic dependency submission - enum: - - enabled - - disabled - - not_set - dependency_graph_autosubmit_action_options: - type: object - description: Feature options for Automatic dependency submission - properties: - labeled_runners: - type: boolean - description: Whether to use runners labeled with 'dependency-submission' - or standard GitHub runners. - dependabot_alerts: - type: string - description: The enablement status of Dependabot alerts - enum: - - enabled - - disabled - - not_set - dependabot_security_updates: - type: string - description: The enablement status of Dependabot security updates - enum: - - enabled - - disabled - - not_set - code_scanning_default_setup: - type: string - description: The enablement status of code scanning default setup - enum: - - enabled - - disabled - - not_set - secret_scanning: - type: string - description: The enablement status of secret scanning - enum: - - enabled - - disabled - - not_set - secret_scanning_push_protection: - type: string - description: The enablement status of secret scanning push protection - enum: - - enabled - - disabled - - not_set - secret_scanning_delegated_bypass: - type: string - description: The enablement status of secret scanning delegated bypass - enum: - - enabled - - disabled - - not_set - secret_scanning_delegated_bypass_options: - type: object - description: Feature options for secret scanning delegated bypass - properties: - reviewers: - type: array - description: The bypass reviewers for secret scanning delegated bypass - items: - type: object - required: - - reviewer_id - - reviewer_type - properties: - reviewer_id: - type: integer - description: The ID of the team or role selected as a bypass reviewer - reviewer_type: - type: string - description: The type of the bypass reviewer - enum: - - TEAM - - ROLE - secret_scanning_validity_checks: - type: string - description: The enablement status of secret scanning validity checks - enum: - - enabled - - disabled - - not_set - secret_scanning_non_provider_patterns: - type: string - description: The enablement status of secret scanning non-provider patterns - enum: - - enabled - - disabled - - not_set - private_vulnerability_reporting: - type: string - description: The enablement status of private vulnerability reporting - enum: - - enabled - - disabled - - not_set - enforcement: - type: string - description: The enforcement status for a security configuration - enum: - - enforced - - unenforced - url: - type: string - format: uri - description: The URL of the configuration - html_url: - type: string - format: uri - description: The URL of the configuration - created_at: - type: string - format: date-time - updated_at: - type: string - format: date-time - code-security-default-configurations: - type: array - description: A list of default code security configurations - items: - type: object - properties: - default_for_new_repos: - enum: - - public - - private_and_internal - - all - description: The visibility of newly created repositories for which the - code security configuration will be applied to by default - configuration: - "$ref": "#/components/schemas/code-security-configuration" - code-security-configuration-repositories: - type: object - description: Repositories associated with a code security configuration and - attachment status - properties: - status: - type: string - description: The attachment status of the code security configuration on - the repository. - enum: - - attached - - attaching - - detached - - removed - - enforced - - failed - - updating - - removed_by_enterprise - repository: - "$ref": "#/components/schemas/simple-repository" codespace-machine: type: object title: Codespace machine @@ -73990,6 +74690,649 @@ components: - public_code_suggestions - seat_management_setting additionalProperties: true + team-simple: + title: Team Simple + description: Groups of organization members that gives permissions on specified + repositories. + type: object + properties: + id: + description: Unique identifier of the team + type: integer + examples: + - 1 + node_id: + type: string + examples: + - MDQ6VGVhbTE= + url: + description: URL for the team + type: string + format: uri + examples: + - https://api.github.com/organizations/1/team/1 + members_url: + type: string + examples: + - https://api.github.com/organizations/1/team/1/members{/member} + name: + description: Name of the team + type: string + examples: + - Justice League + description: + description: Description of the team + type: + - string + - 'null' + examples: + - A great team. + permission: + description: Permission that the team will have for its repositories + type: string + examples: + - admin + privacy: + description: The level of privacy this team should have + type: string + examples: + - closed + notification_setting: + description: The notification setting the team has set + type: string + examples: + - notifications_enabled + html_url: + type: string + format: uri + examples: + - https://github.com/orgs/rails/teams/core + repositories_url: + type: string + format: uri + examples: + - https://api.github.com/organizations/1/team/1/repos + slug: + type: string + examples: + - justice-league + ldap_dn: + description: Distinguished Name (DN) that team maps to within LDAP environment + type: string + examples: + - uid=example,ou=users,dc=github,dc=com + required: + - id + - node_id + - url + - members_url + - name + - description + - permission + - html_url + - repositories_url + - slug + team: + title: Team + description: Groups of organization members that gives permissions on specified + repositories. + type: object + properties: + id: + type: integer + node_id: + type: string + name: + type: string + slug: + type: string + description: + type: + - string + - 'null' + privacy: + type: string + notification_setting: + type: string + permission: + type: string + permissions: + type: object + properties: + pull: + type: boolean + triage: + type: boolean + push: + type: boolean + maintain: + type: boolean + admin: + type: boolean + required: + - pull + - triage + - push + - maintain + - admin + url: + type: string + format: uri + html_url: + type: string + format: uri + examples: + - https://github.com/orgs/rails/teams/core + members_url: + type: string + repositories_url: + type: string + format: uri + parent: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/team-simple" + required: + - id + - node_id + - url + - members_url + - name + - description + - permission + - html_url + - repositories_url + - slug + - parent + enterprise-team: + title: Enterprise Team + description: Group of enterprise owners and/or members + type: object + properties: + id: + type: integer + format: int64 + name: + type: string + slug: + type: string + url: + type: string + format: uri + sync_to_organizations: + type: string + examples: + - disabled | all + group_id: + type: + - string + - 'null' + examples: + - 62ab9291-fae2-468e-974b-7e45096d5021 + html_url: + type: string + format: uri + examples: + - https://github.com/enterprises/dc/teams/justice-league + members_url: + type: string + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + required: + - id + - url + - members_url + - sync_to_organizations + - name + - html_url + - slug + - created_at + - updated_at + copilot-seat-details: + title: Copilot Business Seat Detail + description: Information about a Copilot Business seat assignment for a user, + team, or organization. + type: object + properties: + assignee: + "$ref": "#/components/schemas/simple-user" + organization: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/organization-simple" + assigning_team: + description: The team through which the assignee is granted access to GitHub + Copilot, if applicable. + oneOf: + - "$ref": "#/components/schemas/team" + - "$ref": "#/components/schemas/enterprise-team" + type: + - 'null' + - object + pending_cancellation_date: + type: + - string + - 'null' + format: date + description: The pending cancellation date for the seat, in `YYYY-MM-DD` + format. This will be null unless the assignee's Copilot access has been + canceled during the current billing cycle. If the seat has been cancelled, + this corresponds to the start of the organization's next billing cycle. + last_activity_at: + type: + - string + - 'null' + format: date-time + description: Timestamp of user's last GitHub Copilot activity, in ISO 8601 + format. + last_activity_editor: + type: + - string + - 'null' + description: Last editor that was used by the user for a GitHub Copilot + completion. + created_at: + type: string + format: date-time + description: Timestamp of when the assignee was last granted access to GitHub + Copilot, in ISO 8601 format. + updated_at: + type: string + format: date-time + deprecated: true + description: "**Closing down notice:** This field is no longer relevant + and is closing down. Use the `created_at` field to determine when the + assignee was last granted access to GitHub Copilot. Timestamp of when + the assignee's GitHub Copilot access was last updated, in ISO 8601 format." + plan_type: + type: string + description: The Copilot plan of the organization, or the parent enterprise, + when applicable. + enum: + - business + - enterprise + - unknown + required: + - assignee + - created_at + additionalProperties: false + copilot-ide-code-completions: + type: + - object + - 'null' + description: Usage metrics for Copilot editor code completions in the IDE. + additionalProperties: true + properties: + total_engaged_users: + type: integer + description: Number of users who accepted at least one Copilot code suggestion, + across all active editors. Includes both full and partial acceptances. + languages: + type: array + description: Code completion metrics for active languages. + items: + type: object + description: Usage metrics for a given language for the given editor for + Copilot code completions. + properties: + name: + type: string + description: Name of the language used for Copilot code completion + suggestions. + total_engaged_users: + type: integer + description: Number of users who accepted at least one Copilot code + completion suggestion for the given language. Includes both full + and partial acceptances. + editors: + type: array + items: + type: object + description: Copilot code completion metrics for active editors. + additionalProperties: true + properties: + name: + type: string + description: Name of the given editor. + total_engaged_users: + type: integer + description: Number of users who accepted at least one Copilot code + completion suggestion for the given editor. Includes both full and + partial acceptances. + models: + type: array + description: List of model metrics for custom models and the default + model. + items: + type: object + properties: + name: + type: string + description: Name of the model used for Copilot code completion + suggestions. If the default model is used will appear as 'default'. + is_custom_model: + type: boolean + description: Indicates whether a model is custom or default. + custom_model_training_date: + type: + - string + - 'null' + description: The training date for the custom model. + total_engaged_users: + type: integer + description: Number of users who accepted at least one Copilot + code completion suggestion for the given editor, for the given + language and model. Includes both full and partial acceptances. + languages: + type: array + description: Code completion metrics for active languages, for + the given editor. + items: + type: object + description: Usage metrics for a given language for the given + editor for Copilot code completions. + properties: + name: + type: string + description: Name of the language used for Copilot code + completion suggestions, for the given editor. + total_engaged_users: + type: integer + description: Number of users who accepted at least one + Copilot code completion suggestion for the given editor, + for the given language. Includes both full and partial + acceptances. + total_code_suggestions: + type: integer + description: The number of Copilot code suggestions generated + for the given editor, for the given language. + total_code_acceptances: + type: integer + description: The number of Copilot code suggestions accepted + for the given editor, for the given language. Includes + both full and partial acceptances. + total_code_lines_suggested: + type: integer + description: The number of lines of code suggested by + Copilot code completions for the given editor, for the + given language. + total_code_lines_accepted: + type: integer + description: The number of lines of code accepted from + Copilot code suggestions for the given editor, for the + given language. + copilot-ide-chat: + type: + - object + - 'null' + description: Usage metrics for Copilot Chat in the IDE. + additionalProperties: true + properties: + total_engaged_users: + type: integer + description: Total number of users who prompted Copilot Chat in the IDE. + editors: + type: array + items: + type: object + description: Copilot Chat metrics, for active editors. + properties: + name: + type: string + description: Name of the given editor. + total_engaged_users: + type: integer + description: The number of users who prompted Copilot Chat in the + specified editor. + models: + type: array + description: List of model metrics for custom models and the default + model. + items: + type: object + properties: + name: + type: string + description: Name of the model used for Copilot code completion + suggestions. If the default model is used will appear as 'default'. + is_custom_model: + type: boolean + description: Indicates whether a model is custom or default. + custom_model_training_date: + type: + - string + - 'null' + description: The training date for the custom model. + total_engaged_users: + type: integer + description: The number of users who prompted Copilot Chat in + the given editor and model. + total_chats: + type: integer + description: The total number of chats initiated by users in + the given editor and model. + total_chat_insertion_events: + type: integer + description: The number of times users accepted a code suggestion + from Copilot Chat using the 'Insert Code' UI element, for + the given editor. + total_chat_copy_events: + type: integer + description: The number of times users copied a code suggestion + from Copilot Chat using the keyboard, or the 'Copy' UI element, + for the given editor. + copilot-dotcom-chat: + type: + - object + - 'null' + description: Usage metrics for Copilot Chat in github.com + additionalProperties: true + properties: + total_engaged_users: + type: integer + description: Total number of users who prompted Copilot Chat on github.com + at least once. + models: + type: array + description: List of model metrics for a custom models and the default model. + items: + type: object + properties: + name: + type: string + description: Name of the model used for Copilot code completion suggestions. + If the default model is used will appear as 'default'. + is_custom_model: + type: boolean + description: Indicates whether a model is custom or default. + custom_model_training_date: + type: + - string + - 'null' + description: The training date for the custom model (if applicable). + total_engaged_users: + type: integer + description: Total number of users who prompted Copilot Chat on github.com + at least once for each model. + total_chats: + type: integer + description: Total number of chats initiated by users on github.com. + copilot-dotcom-pull-requests: + type: + - object + - 'null' + description: Usage metrics for Copilot for pull requests. + additionalProperties: true + properties: + total_engaged_users: + type: integer + description: The number of users who used Copilot for Pull Requests on github.com + to generate a pull request summary at least once. + repositories: + type: array + description: Repositories in which users used Copilot for Pull Requests + to generate pull request summaries + items: + type: object + properties: + name: + type: string + description: Repository name + total_engaged_users: + type: integer + description: The number of users who generated pull request summaries + using Copilot for Pull Requests in the given repository. + models: + type: array + description: List of model metrics for custom models and the default + model. + items: + type: object + properties: + name: + type: string + description: Name of the model used for Copilot code completion + suggestions. If the default model is used will appear as 'default'. + is_custom_model: + type: boolean + description: Indicates whether a model is custom or default. + custom_model_training_date: + type: + - string + - 'null' + description: The training date for the custom model. + total_pr_summaries_created: + type: integer + description: The number of pull request summaries generated + using Copilot for Pull Requests in the given repository. + total_engaged_users: + type: integer + description: The number of users who generated pull request + summaries using Copilot for Pull Requests in the given repository + and model. + copilot-usage-metrics-day: + title: Copilot Usage Metrics + description: Copilot usage metrics for a given day. + type: object + properties: + date: + type: string + format: date + description: The date for which the usage metrics are aggregated, in `YYYY-MM-DD` + format. + total_active_users: + type: integer + description: The total number of Copilot users with activity belonging to + any Copilot feature, globally, for the given day. Includes passive activity + such as receiving a code suggestion, as well as engagement activity such + as accepting a code suggestion or prompting chat. Does not include authentication + events. Is not limited to the individual features detailed on the endpoint. + total_engaged_users: + type: integer + description: The total number of Copilot users who engaged with any Copilot + feature, for the given day. Examples include but are not limited to accepting + a code suggestion, prompting Copilot chat, or triggering a PR Summary. + Does not include authentication events. Is not limited to the individual + features detailed on the endpoint. + copilot_ide_code_completions: + "$ref": "#/components/schemas/copilot-ide-code-completions" + copilot_ide_chat: + "$ref": "#/components/schemas/copilot-ide-chat" + copilot_dotcom_chat: + "$ref": "#/components/schemas/copilot-dotcom-chat" + copilot_dotcom_pull_requests: + "$ref": "#/components/schemas/copilot-dotcom-pull-requests" + required: + - date + additionalProperties: true + copilot-usage-metrics: + title: Copilot Usage Metrics + description: Summary of Copilot usage. + type: object + properties: + day: + type: string + format: date + description: The date for which the usage metrics are reported, in `YYYY-MM-DD` + format. + total_suggestions_count: + type: integer + description: The total number of Copilot code completion suggestions shown + to users. + total_acceptances_count: + type: integer + description: The total number of Copilot code completion suggestions accepted + by users. + total_lines_suggested: + type: integer + description: The total number of lines of code completions suggested by + Copilot. + total_lines_accepted: + type: integer + description: The total number of lines of code completions accepted by users. + total_active_users: + type: integer + description: The total number of users who were shown Copilot code completion + suggestions during the day specified. + total_chat_acceptances: + type: integer + description: The total instances of users who accepted code suggested by + Copilot Chat in the IDE (panel and inline). + total_chat_turns: + type: integer + description: The total number of chat turns (prompt and response pairs) + sent between users and Copilot Chat in the IDE. + total_active_chat_users: + type: integer + description: The total number of users who interacted with Copilot Chat + in the IDE during the day specified. + breakdown: + type: + - array + - 'null' + description: Breakdown of Copilot code completions usage by language and + editor + items: + type: object + description: Breakdown of Copilot usage by editor for this language + additionalProperties: true + properties: + language: + type: string + description: The language in which Copilot suggestions were shown + to users in the specified editor. + editor: + type: string + description: The editor in which Copilot suggestions were shown to + users for the specified language. + suggestions_count: + type: integer + description: The number of Copilot suggestions shown to users in the + editor specified during the day specified. + acceptances_count: + type: integer + description: The number of Copilot suggestions accepted by users in + the editor specified during the day specified. + lines_suggested: + type: integer + description: The number of lines of code suggested by Copilot in the + editor specified during the day specified. + lines_accepted: + type: integer + description: The number of lines of code accepted by users in the + editor specified during the day specified. + active_users: + type: integer + description: The number of users who were shown Copilot completion + suggestions in the editor specified during the day specified. + required: + - day + - breakdown + additionalProperties: false organization-dependabot-secret: title: Dependabot Secret for an Organization description: Secrets for GitHub Dependabot for an organization. @@ -74574,6 +75917,28 @@ components: type: - string - 'null' + base_role: + type: + - string + - 'null' + description: The system role from which this role inherits permissions. + enum: + - read + - triage + - write + - maintain + - admin + - + source: + type: + - string + - 'null' + description: Source answers the question, "where did this role come from?" + enum: + - Organization + - Enterprise + - Predefined + - permissions: description: A list of permissions included in this role. type: array @@ -74603,6 +75968,16 @@ components: description: The Relationship a Team has with a role. type: object properties: + assignment: + type: string + description: Determines if the team has a direct, indirect, or mixed relationship + to a role + enum: + - direct + - indirect + - mixed + examples: + - direct id: type: integer node_id: @@ -74674,6 +76049,21 @@ components: description: The Relationship a User has with a role. type: object properties: + assignment: + type: string + description: Determines if the user has a direct, indirect, or mixed relationship + to a role + enum: + - direct + - indirect + - mixed + examples: + - direct + inherited_from: + description: Team the user has gotten the role through + type: array + items: + "$ref": "#/components/schemas/team-simple" name: type: - string @@ -75048,6 +76438,95 @@ components: - token_expired - token_expires_at - token_last_used_at + org-private-registry-configuration: + title: Organization private registry + description: Private registry configuration for an organization + type: object + properties: + name: + description: The name of the private registry configuration. + type: string + examples: + - MAVEN_REPOSITORY_SECRET + registry_type: + description: The registry type. + enum: + - maven_repository + type: string + username: + description: The username to use when authenticating with the private registry. + type: + - string + - 'null' + examples: + - monalisa + visibility: + description: Which type of organization repositories have access to the + private registry. + enum: + - all + - private + - selected + type: string + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + required: + - name + - registry_type + - visibility + - created_at + - updated_at + org-private-registry-configuration-with-selected-repositories: + title: Organization private registry + description: Private registry configuration for an organization + type: object + properties: + name: + description: The name of the private registry configuration. + type: string + examples: + - MAVEN_REPOSITORY_SECRET + registry_type: + description: The registry type. + enum: + - maven_repository + type: string + username: + description: The username to use when authenticating with the private registry. + type: string + examples: + - monalisa + visibility: + description: Which type of organization repositories have access to the + private registry. `selected` means only the repositories specified by + `selected_repository_ids` can access the private registry. + enum: + - all + - private + - selected + type: string + selected_repository_ids: + type: array + description: An array of repository IDs that can access the organization + private registry when `visibility` is set to `selected`. + items: + type: integer + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + required: + - name + - registry_type + - visibility + - created_at + - updated_at project: title: Project description: Projects are a way to organize columns and cards of work. @@ -75156,6 +76635,14 @@ components: format: uri description: The URL that can be used to fetch, update, or delete info about this property via the API. + source_type: + type: string + description: The source type of the property + enum: + - organization + - enterprise + examples: + - organization value_type: type: string enum: @@ -75210,6 +76697,53 @@ components: required: - property_name - value_type + custom-property-set-payload: + title: Custom Property Set Payload + description: Custom property set payload + type: object + properties: + value_type: + type: string + enum: + - string + - single_select + - multi_select + - true_false + description: The type of the value for the property + examples: + - single_select + required: + type: boolean + description: Whether the property is required. + default_value: + oneOf: + - type: string + - type: array + items: + type: string + description: Default value of the property + type: + - 'null' + - string + - array + description: + type: + - string + - 'null' + description: Short description of the property + allowed_values: + type: + - array + - 'null' + items: + type: string + maxLength: 75 + maxItems: 200 + description: |- + An ordered list of the allowed values of the property. + The property can have up to 200 allowed values. + required: + - value_type custom-property-value: title: Custom Property Value description: Custom property name and associated value @@ -76000,6 +77534,7 @@ components: Conditions for an organization ruleset. The branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties. The push rulesets conditions object does not require the `ref_name` property. + For repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`. oneOf: - type: object title: repository_name_and_ref_name @@ -76217,6 +77752,13 @@ components: parameters: type: object properties: + allowed_merge_methods: + type: array + description: When merging pull requests, you can allow any combination + of merge commits, squashing, or rebasing. At least one option must + be enabled. + items: + type: string dismiss_stale_reviews_on_push: type: boolean description: New, reviewable commits pushed will dismiss previous pull @@ -76722,12 +78264,14 @@ components: - branch - tag - push + - repository source_type: type: string description: The type of the source of the ruleset enum: - Repository - Organization + - Enterprise source: type: string description: The name of the source @@ -78746,6 +80290,8 @@ components: "$ref": "#/components/schemas/rate-limit" dependency_snapshots: "$ref": "#/components/schemas/rate-limit" + code_scanning_autofix: + "$ref": "#/components/schemas/rate-limit" required: - core - search @@ -80644,6 +82190,10 @@ components: type: - string - 'null' + verified_at: + type: + - string + - 'null' required: - verified - reason @@ -81728,6 +83278,62 @@ components: enum: - open - dismissed + code-scanning-autofix-status: + type: string + description: The status of an autofix. + enum: + - pending + - error + - success + - outdated + code-scanning-autofix-description: + type: + - string + - 'null' + description: The description of an autofix. + code-scanning-autofix-started-at: + type: string + description: 'The start time of an autofix in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' + format: date-time + readOnly: true + code-scanning-autofix: + type: object + properties: + status: + "$ref": "#/components/schemas/code-scanning-autofix-status" + description: + "$ref": "#/components/schemas/code-scanning-autofix-description" + started_at: + "$ref": "#/components/schemas/code-scanning-autofix-started-at" + required: + - status + - description + - started_at + code-scanning-autofix-commits: + description: Commit an autofix for a code scanning alert + type: + - object + - 'null' + properties: + target_ref: + description: The Git reference of target branch for the commit. Branch needs + to already exist. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" + in the Git documentation. + type: string + message: + description: Commit message to be used. + type: string + code-scanning-autofix-commits-response: + type: object + properties: + target_ref: + type: string + description: The Git reference of target branch for the commit. For more + information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" + in the Git documentation. + sha: + type: string + description: SHA of commit with autofix. code-scanning-analysis-sarif-id: type: string description: An identifier for the upload. @@ -82138,6 +83744,7 @@ components: items: type: string enum: + - actions - c-cpp - csharp - go @@ -82180,6 +83787,19 @@ components: enum: - configured - not-configured + runner_type: + description: Runner type to be used. + type: string + enum: + - standard + - labeled + runner_label: + description: Runner label to be used if the runner type is labeled. + type: + - string + - 'null' + examples: + - code-scanning query_suite: description: CodeQL query suite to be used. type: string @@ -82192,6 +83812,7 @@ components: items: type: string enum: + - actions - c-cpp - csharp - go @@ -83827,6 +85448,10 @@ components: type: - string - 'null' + verified_at: + type: + - string + - 'null' secret-scanning-push-protection-bypass-placeholder-id: description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -85046,6 +86671,10 @@ components: type: - string - 'null' + verified_at: + type: + - string + - 'null' required: - verified - reason @@ -86729,6 +88358,10 @@ components: type: - string - 'null' + verified_at: + type: + - string + - 'null' required: - verified - reason @@ -88775,6 +90408,26 @@ components: format: date-time description: 'The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' + push_protection_bypass_request_reviewer: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + push_protection_bypass_request_reviewer_comment: + type: + - string + - 'null' + description: An optional comment when reviewing a push protection bypass. + push_protection_bypass_request_comment: + type: + - string + - 'null' + description: An optional comment when requesting a push protection bypass. + push_protection_bypass_request_html_url: + type: + - string + - 'null' + format: uri + description: The URL to a push protection bypass request. validity: type: string description: The token status as of the latest validity check. @@ -88994,7 +90647,7 @@ components: format: uri description: The API URL to get the pull request where the secret was detected. examples: - - https://api.github.com/repos/octocat/Hello-World/pull/2846 + - https://api.github.com/repos/octocat/Hello-World/pulls/2846 required: - pull_request_title_url secret-scanning-location-pull-request-body: @@ -89008,7 +90661,7 @@ components: format: uri description: The API URL to get the pull request where the secret was detected. examples: - - https://api.github.com/repos/octocat/Hello-World/pull/2846 + - https://api.github.com/repos/octocat/Hello-World/pulls/2846 required: - pull_request_body_url secret-scanning-location-pull-request-comment: @@ -89116,6 +90769,59 @@ components: token_type: type: string description: The token type this bypass is for. + secret-scanning-scan: + description: Information on a single scan performed by secret scanning on the + repository + type: object + properties: + type: + type: string + description: The type of scan + status: + type: string + description: The state of the scan. Either "completed", "running", or "pending" + completed_at: + type: + - string + - 'null' + format: date-time + description: The time that the scan was completed. Empty if the scan is + running + started_at: + type: + - string + - 'null' + format: date-time + description: The time that the scan was started. Empty if the scan is pending + secret-scanning-scan-history: + type: object + properties: + incremental_scans: + type: array + items: + "$ref": "#/components/schemas/secret-scanning-scan" + pattern_update_scans: + type: array + items: + "$ref": "#/components/schemas/secret-scanning-scan" + backfill_scans: + type: array + items: + "$ref": "#/components/schemas/secret-scanning-scan" + custom_pattern_backfill_scans: + type: array + items: + allOf: + - "$ref": "#/components/schemas/secret-scanning-scan" + - type: object + properties: + pattern_name: + type: string + description: Name of the custom pattern for custom pattern scans + pattern_scope: + type: string + description: Level at which the custom pattern is defined, one of + "repository", "organization", or "enterprise" repository-advisory-create: type: object properties: @@ -90005,6 +91711,20 @@ components: type: - string - 'null' + sub_issues_summary: + title: Sub-issues Summary + type: object + properties: + total: + type: integer + completed: + type: integer + percent_completed: + type: integer + required: + - total + - completed + - percent_completed state: type: string state_reason: @@ -95118,6 +96838,20 @@ components: repository_url: type: string format: uri + sub_issues_summary: + title: Sub-issues Summary + type: object + properties: + total: + type: integer + completed: + type: integer + percent_completed: + type: integer + required: + - total + - completed + - percent_completed state: description: State of the issue; either 'open' or 'closed' type: string @@ -96184,6 +97918,20 @@ components: repository_url: type: string format: uri + sub_issues_summary: + title: Sub-issues Summary + type: object + properties: + total: + type: integer + completed: + type: integer + percent_completed: + type: integer + required: + - total + - completed + - percent_completed state: description: State of the issue; either 'open' or 'closed' type: string @@ -101245,6 +102993,26 @@ components: format: date-time description: 'The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' + push_protection_bypass_request_reviewer: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + push_protection_bypass_request_reviewer_comment: + type: + - string + - 'null' + description: An optional comment when reviewing a push protection bypass. + push_protection_bypass_request_comment: + type: + - string + - 'null' + description: An optional comment when requesting a push protection bypass. + push_protection_bypass_request_html_url: + type: + - string + - 'null' + format: uri + description: The URL to a push protection bypass request. publicly_leaked: type: - boolean @@ -113659,6 +115427,20 @@ components: repository_url: type: string format: uri + sub_issues_summary: + title: Sub-issues Summary + type: object + properties: + total: + type: integer + completed: + type: integer + percent_completed: + type: integer + required: + - total + - completed + - percent_completed state: description: State of the issue; either 'open' or 'closed' type: string @@ -114856,6 +116638,20 @@ components: repository_url: type: string format: uri + sub_issues_summary: + title: Sub-issues Summary + type: object + properties: + total: + type: integer + completed: + type: integer + percent_completed: + type: integer + required: + - total + - completed + - percent_completed state: description: State of the issue; either 'open' or 'closed' type: string @@ -116060,6 +117856,20 @@ components: repository_url: type: string format: uri + sub_issues_summary: + title: Sub-issues Summary + type: object + properties: + total: + type: integer + completed: + type: integer + percent_completed: + type: integer + required: + - total + - completed + - percent_completed state: description: State of the issue; either 'open' or 'closed' type: string @@ -117289,6 +119099,20 @@ components: repository_url: type: string format: uri + sub_issues_summary: + title: Sub-issues Summary + type: object + properties: + total: + type: integer + completed: + type: integer + percent_completed: + type: integer + required: + - total + - completed + - percent_completed state: description: State of the issue; either 'open' or 'closed' type: string @@ -118377,6 +120201,20 @@ components: repository_url: type: string format: uri + sub_issues_summary: + title: Sub-issues Summary + type: object + properties: + total: + type: integer + completed: + type: integer + percent_completed: + type: integer + required: + - total + - completed + - percent_completed state: description: State of the issue; either 'open' or 'closed' type: string @@ -119346,6 +121184,20 @@ components: repository_url: type: string format: uri + sub_issues_summary: + title: Sub-issues Summary + type: object + properties: + total: + type: integer + completed: + type: integer + percent_completed: + type: integer + required: + - total + - completed + - percent_completed state: description: State of the issue; either 'open' or 'closed' type: string @@ -120297,6 +122149,20 @@ components: repository_url: type: string format: uri + sub_issues_summary: + title: Sub-issues Summary + type: object + properties: + total: + type: integer + completed: + type: integer + percent_completed: + type: integer + required: + - total + - completed + - percent_completed state: description: State of the issue; either 'open' or 'closed' type: string @@ -121250,6 +123116,20 @@ components: repository_url: type: string format: uri + sub_issues_summary: + title: Sub-issues Summary + type: object + properties: + total: + type: integer + completed: + type: integer + percent_completed: + type: integer + required: + - total + - completed + - percent_completed state: description: State of the issue; either 'open' or 'closed' type: string @@ -122227,6 +124107,20 @@ components: repository_url: type: string format: uri + sub_issues_summary: + title: Sub-issues Summary + type: object + properties: + total: + type: integer + completed: + type: integer + percent_completed: + type: integer + required: + - total + - completed + - percent_completed state: description: State of the issue; either 'open' or 'closed' type: string @@ -123173,6 +125067,20 @@ components: repository_url: type: string format: uri + sub_issues_summary: + title: Sub-issues Summary + type: object + properties: + total: + type: integer + completed: + type: integer + percent_completed: + type: integer + required: + - total + - completed + - percent_completed state: description: State of the issue; either 'open' or 'closed' type: string @@ -124101,6 +126009,20 @@ components: repository_url: type: string format: uri + sub_issues_summary: + title: Sub-issues Summary + type: object + properties: + total: + type: integer + completed: + type: integer + percent_completed: + type: integer + required: + - total + - completed + - percent_completed state: description: State of the issue; either 'open' or 'closed' type: string @@ -125509,6 +127431,20 @@ components: repository_url: type: string format: uri + sub_issues_summary: + title: Sub-issues Summary + type: object + properties: + total: + type: integer + completed: + type: integer + percent_completed: + type: integer + required: + - total + - completed + - percent_completed state: description: State of the issue; either 'open' or 'closed' type: string @@ -126506,6 +128442,20 @@ components: repository_url: type: string format: uri + sub_issues_summary: + title: Sub-issues Summary + type: object + properties: + total: + type: integer + completed: + type: integer + percent_completed: + type: integer + required: + - total + - completed + - percent_completed state: description: State of the issue; either 'open' or 'closed' type: string @@ -127430,6 +129380,20 @@ components: repository_url: type: string format: uri + sub_issues_summary: + title: Sub-issues Summary + type: object + properties: + total: + type: integer + completed: + type: integer + percent_completed: + type: integer + required: + - total + - completed + - percent_completed state: description: State of the issue; either 'open' or 'closed' type: string @@ -128944,6 +130908,20 @@ components: repository_url: type: string format: uri + sub_issues_summary: + title: Sub-issues Summary + type: object + properties: + total: + type: integer + completed: + type: integer + percent_completed: + type: integer + required: + - total + - completed + - percent_completed state: description: State of the issue; either 'open' or 'closed' type: string @@ -191171,6 +193149,79 @@ components: - action - alert - repository + webhook-secret-scanning-scan-completed: + title: secret_scanning_scan completed event + type: object + properties: + action: + type: string + enum: + - completed + type: + type: string + description: What type of scan was completed + enum: + - backfill + - custom-pattern-backfill + - pattern-version-backfill + source: + type: string + description: What type of content was scanned + enum: + - git + - issues + - pull-requests + - discussions + - wiki + started_at: + type: string + format: date-time + description: 'The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' + completed_at: + type: string + format: date-time + description: 'The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' + secret_types: + type: + - array + - 'null' + description: List of patterns that were updated. This will be empty for + normal backfill scans or custom pattern updates + items: + type: string + custom_pattern_name: + type: + - string + - 'null' + description: If the scan was triggered by a custom pattern update, this + will be the name of the pattern that was updated + custom_pattern_scope: + type: + - string + - 'null' + description: If the scan was triggered by a custom pattern update, this + will be the scope of the pattern that was updated + enum: + - repository + - organization + - enterprise + - + repository: + "$ref": "#/components/schemas/repository-webhooks" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - source + - type + - started_at + - completed_at webhook-security-advisory-published: title: security_advisory published event type: object @@ -191830,6 +193881,10 @@ components: - 'null' verified: type: boolean + verified_at: + type: + - string + - 'null' required: - verified - reason @@ -201313,236 +203368,244 @@ components: zombie_man: https://github.githubassets.com/images/icons/emoji/unicode/1f9df-2642.png?v8 zombie_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f9df-2640.png?v8 zzz: https://github.githubassets.com/images/icons/emoji/unicode/1f4a4.png?v8 - copilot-seats-list: + enterprise-code-security-configuration-list: value: - total_seats: 2 - seats: - - created_at: '2021-08-03T18:00:00-06:00' - updated_at: '2021-09-23T15:00:00-06:00' - pending_cancellation_date: - last_activity_at: '2021-10-14T00:53:32-06:00' - last_activity_editor: vscode/1.77.3/copilot/1.86.82 - plan_type: business - assignee: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - assigning_team: - id: 1 - node_id: MDQ6VGVhbTE= - url: https://api.github.com/teams/1 - html_url: https://github.com/orgs/github/teams/justice-league - name: Justice League - slug: justice-league - description: A great team. - privacy: closed - notification_setting: notifications_enabled - permission: admin - members_url: https://api.github.com/teams/1/members{/member} - repositories_url: https://api.github.com/teams/1/repos - parent: - - created_at: '2021-09-23T18:00:00-06:00' - updated_at: '2021-09-23T15:00:00-06:00' - pending_cancellation_date: '2021-11-01' - last_activity_at: '2021-10-13T00:53:32-06:00' - last_activity_editor: vscode/1.77.3/copilot/1.86.82 - assignee: - login: octokitten - id: 1 - node_id: MDQ76VNlcjE= - avatar_url: https://github.com/images/error/octokitten_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octokitten - html_url: https://github.com/octokitten - followers_url: https://api.github.com/users/octokitten/followers - following_url: https://api.github.com/users/octokitten/following{/other_user} - gists_url: https://api.github.com/users/octokitten/gists{/gist_id} - starred_url: https://api.github.com/users/octokitten/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octokitten/subscriptions - organizations_url: https://api.github.com/users/octokitten/orgs - repos_url: https://api.github.com/users/octokitten/repos - events_url: https://api.github.com/users/octokitten/events{/privacy} - received_events_url: https://api.github.com/users/octokitten/received_events - type: User - site_admin: false - copilot-usage-metrics-for-day: + - id: 17 + target_type: global + name: GitHub recommended + description: Suggested settings for Dependabot, secret scanning, and code + scanning. + advanced_security: enabled + dependency_graph: enabled + dependency_graph_autosubmit_action: not_set + dependency_graph_autosubmit_action_options: + labeled_runners: false + dependabot_alerts: enabled + dependabot_security_updates: not_set + code_scanning_default_setup: enabled + code_scanning_default_setup_options: + runner_type: not_set + runner_label: + secret_scanning: enabled + secret_scanning_push_protection: enabled + secret_scanning_validity_checks: enabled + secret_scanning_non_provider_patterns: enabled + private_vulnerability_reporting: enabled + enforcement: enforced + url: https://api.github.com/enterprises/octo-enterprise/code-security/configurations/17 + html_url: https://github.com/organizations/octo-enterprise/settings/security_analysis/configurations/17/view + created_at: '2023-12-04T15:58:07Z' + updated_at: '2023-12-04T15:58:07Z' + - id: 1326 + target_type: enterprise + name: High risk settings + description: This is a code security configuration for octo-enterprise high + risk repositories + advanced_security: enabled + dependency_graph: enabled + dependency_graph_autosubmit_action: enabled + dependency_graph_autosubmit_action_options: + labeled_runners: false + dependabot_alerts: enabled + dependabot_security_updates: enabled + code_scanning_default_setup: enabled + code_scanning_default_setup_options: + runner_type: not_set + runner_label: + secret_scanning: enabled + secret_scanning_push_protection: enabled + secret_scanning_validity_checks: disabled + secret_scanning_non_provider_patterns: disabled + private_vulnerability_reporting: enabled + enforcement: enforced + url: https://api.github.com/enterprises/octo-enterprise/code-security/configurations/1326 + html_url: https://github.com/enterprises/octo-enterprise/settings/security_analysis/configurations/1326/edit + created_at: '2024-05-10T00:00:00Z' + updated_at: '2024-05-10T00:00:00Z' + enterprise-code-security-configuration: value: - - date: '2024-06-24' - total_active_users: 24 - total_engaged_users: 20 - copilot_ide_code_completions: - total_engaged_users: 20 - languages: - - name: python - total_engaged_users: 10 - - name: ruby - total_engaged_users: 10 - editors: - - name: vscode - total_engaged_users: 13 - models: - - name: default - is_custom_model: false - custom_model_training_date: - total_engaged_users: 13 - languages: - - name: python - total_engaged_users: 6 - total_code_suggestions: 249 - total_code_acceptances: 123 - total_code_lines_suggested: 225 - total_code_lines_accepted: 135 - - name: ruby - total_engaged_users: 7 - total_code_suggestions: 496 - total_code_acceptances: 253 - total_code_lines_suggested: 520 - total_code_lines_accepted: 270 - - name: neovim - total_engaged_users: 7 - models: - - name: a-custom-model - is_custom_model: true - custom_model_training_date: '2024-02-01' - languages: - - name: typescript - total_engaged_users: 3 - total_code_suggestions: 112 - total_code_acceptances: 56 - total_code_lines_suggested: 143 - total_code_lines_accepted: 61 - - name: go - total_engaged_users: 4 - total_code_suggestions: 132 - total_code_acceptances: 67 - total_code_lines_suggested: 154 - total_code_lines_accepted: 72 - copilot_ide_chat: - total_engaged_users: 13 - editors: - - name: vscode - total_engaged_users: 13 - models: - - name: default - is_custom_model: false - custom_model_training_date: - total_engaged_users: 12 - total_chats: 45 - total_chat_insertion_events: 12 - total_chat_copy_events: 16 - - name: a-custom-model - is_custom_model: true - custom_model_training_date: '2024-02-01' - total_engaged_users: 1 - total_chats: 10 - total_chat_insertion_events: 11 - total_chat_copy_events: 3 - copilot_dotcom_chat: - total_engaged_users: 14 - models: - - name: default - is_custom_model: false - custom_model_training_date: - total_engaged_users: 14 - total_chats: 38 - copilot_dotcom_pull_requests: - total_engaged_users: 12 - repositories: - - name: demo/repo1 - total_engaged_users: 8 - models: - - name: default - is_custom_model: false - custom_model_training_date: - total_pr_summaries_created: 6 - total_engaged_users: 8 - - name: demo/repo2 - total_engaged_users: 4 - models: - - name: a-custom-model - is_custom_model: true - custom_model_training_date: '2024-02-01' - total_pr_summaries_created: 10 - total_engaged_users: 4 - copilot-usage-metrics-enterprise: + id: 1325 + target_type: enterprise + name: High risk settings + description: This is a code security configuration for octo-enterprise + advanced_security: enabled + dependency_graph: enabled + dependency_graph_autosubmit_action: enabled + dependency_graph_autosubmit_action_options: + labeled_runners: false + dependabot_alerts: enabled + dependabot_security_updates: not_set + code_scanning_default_setup: disabled + secret_scanning: enabled + secret_scanning_push_protection: disabled + secret_scanning_delegated_bypass: disabled + secret_scanning_validity_checks: disabled + secret_scanning_non_provider_patterns: disabled + private_vulnerability_reporting: disabled + enforcement: enforced + url: https://api.github.com/enterprises/octo-enterprise/code-security/configurations/1325 + html_url: https://github.com/enterprises/octo-enterprise/settings/security_analysis/configurations/1325/edit + created_at: '2024-05-01T00:00:00Z' + updated_at: '2024-05-01T00:00:00Z' + code-security-default-configurations: value: - - day: '2023-10-15' - total_suggestions_count: 5000 - total_acceptances_count: 3000 - total_lines_suggested: 7000 - total_lines_accepted: 3500 - total_active_users: 15 - total_chat_acceptances: 45 - total_chat_turns: 350 - total_active_chat_users: 8 - breakdown: - - language: python - editor: vscode - suggestions_count: 3000 - acceptances_count: 2000 - lines_suggested: 3000 - lines_accepted: 1500 - active_users: 5 - - language: python - editor: jetbrains - suggestions_count: 1000 - acceptances_count: 500 - lines_suggested: 2000 - lines_accepted: 1000 - active_users: 5 - - language: javascript - editor: vscode - suggestions_count: 1000 - acceptances_count: 500 - lines_suggested: 2000 - lines_accepted: 1000 - active_users: 5 - - day: '2023-10-16' - total_suggestions_count: 5200 - total_acceptances_count: 5100 - total_lines_suggested: 5300 - total_lines_accepted: 5000 - total_active_users: 15 - total_chat_acceptances: 57 - total_chat_turns: 455 - total_active_chat_users: 12 - breakdown: - - language: python - editor: vscode - suggestions_count: 3100 - acceptances_count: 3000 - lines_suggested: 3200 - lines_accepted: 3100 - active_users: 5 - - language: python - editor: jetbrains - suggestions_count: 1100 - acceptances_count: 1000 - lines_suggested: 1200 - lines_accepted: 1100 - active_users: 5 - - language: javascript - editor: vscode - suggestions_count: 1000 - acceptances_count: 900 - lines_suggested: 1100 - lines_accepted: 1000 - active_users: 5 + - default_for_new_repos: public + configuration: + id: 1325 + target_type: organization + name: octo-org recommended settings + description: This is a code security configuration for octo-org + advanced_security: enabled + dependency_graph: enabled + dependency_graph_autosubmit_action: not_set + dependency_graph_autosubmit_action_options: + labeled_runners: false + dependabot_alerts: enabled + dependabot_security_updates: not_set + code_scanning_default_setup: enabled + code_scanning_default_setup_options: + runner_type: not_set + runner_label: + secret_scanning: enabled + secret_scanning_push_protection: enabled + secret_scanning_delegated_bypass: enabled + secret_scanning_delegated_bypass_options: + reviewers: + - security_configuration_id: 1325 + reviewer_id: 5678 + reviewer_type: TEAM + secret_scanning_validity_checks: enabled + secret_scanning_non_provider_patterns: enabled + private_vulnerability_reporting: enabled + enforcement: enforced + url: https://api.github.com/orgs/octo-org/code-security/configurations/1325 + html_url: https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325 + created_at: '2024-05-01T00:00:00Z' + updated_at: '2024-05-01T00:00:00Z' + - default_for_new_repos: private_and_internal + configuration: + id: 17 + target_type: global + name: GitHub recommended + description: Suggested settings for Dependabot, secret scanning, and code + scanning. + advanced_security: enabled + dependency_graph: enabled + dependency_graph_autosubmit_action: not_set + dependency_graph_autosubmit_action_options: + labeled_runners: false + dependabot_alerts: enabled + dependabot_security_updates: not_set + code_scanning_default_setup: enabled + code_scanning_default_setup_options: + runner_type: not_set + runner_label: + secret_scanning: enabled + secret_scanning_push_protection: enabled + secret_scanning_delegated_bypass: disabled + secret_scanning_validity_checks: disabled + private_vulnerability_reporting: enabled + enforcement: enforced + url: https://api.github.com/orgs/octo-org/code-security/configurations/17 + html_url: https://github.com/organizations/octo-org/settings/security_products/configurations/view + created_at: '2023-12-04T15:58:07Z' + updated_at: '2023-12-04T15:58:07Z' + code-security-configuration: + value: + id: 1325 + target_type: organization + name: octo-org recommended settings + description: This is a code security configuration for octo-org + advanced_security: enabled + dependency_graph: enabled + dependency_graph_autosubmit_action: enabled + dependency_graph_autosubmit_action_options: + labeled_runners: false + dependabot_alerts: enabled + dependabot_security_updates: not_set + code_scanning_default_setup: disabled + code_scanning_default_setup_options: + runner_type: not_set + runner_label: + secret_scanning: enabled + secret_scanning_push_protection: disabled + secret_scanning_delegated_bypass: disabled + secret_scanning_validity_checks: disabled + secret_scanning_non_provider_patterns: disabled + private_vulnerability_reporting: disabled + enforcement: enforced + url: https://api.github.com/orgs/octo-org/code-security/configurations/1325 + html_url: https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325 + created_at: '2024-05-01T00:00:00Z' + updated_at: '2024-05-01T00:00:00Z' + simple-repository: + value: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + hooks_url: http://api.github.com/repos/octocat/Hello-World/hooks dependabot-alerts-for-organization: value: - number: 2 @@ -201972,6 +204035,28 @@ components: site_admin: true push_protection_bypassed: true push_protection_bypassed_at: '2020-11-06T21:48:51Z' + push_protection_bypass_request_reviewer: + login: octocat + id: 3 + node_id: MDQ6VXNlcjI= + avatar_url: https://alambic.github.com/avatars/u/3? + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: true + push_protection_bypass_request_reviewer_comment: Example response + push_protection_bypass_request_comment: Example comment + push_protection_bypass_request_html_url: https://github.com/owner/repo/secret_scanning_exemptions/1 resolution_comment: Example comment validity: active publicly_leaked: false @@ -202056,74 +204141,14 @@ components: push_protection_bypassed_by: push_protection_bypassed: false push_protection_bypassed_at: + push_protection_bypass_request_reviewer: + push_protection_bypass_request_reviewer_comment: + push_protection_bypass_request_comment: + push_protection_bypass_request_html_url: resolution_comment: validity: unknown publicly_leaked: false multi_repo: false - copilot-usage-metrics-org: - value: - - day: '2023-10-15' - total_suggestions_count: 1000 - total_acceptances_count: 800 - total_lines_suggested: 1800 - total_lines_accepted: 1200 - total_active_users: 10 - total_chat_acceptances: 32 - total_chat_turns: 200 - total_active_chat_users: 4 - breakdown: - - language: python - editor: vscode - suggestions_count: 300 - acceptances_count: 250 - lines_suggested: 900 - lines_accepted: 700 - active_users: 5 - - language: python - editor: jetbrains - suggestions_count: 300 - acceptances_count: 200 - lines_suggested: 400 - lines_accepted: 300 - active_users: 2 - - language: ruby - editor: vscode - suggestions_count: 400 - acceptances_count: 350 - lines_suggested: 500 - lines_accepted: 200 - active_users: 3 - - day: '2023-10-16' - total_suggestions_count: 800 - total_acceptances_count: 600 - total_lines_suggested: 1100 - total_lines_accepted: 700 - total_active_users: 12 - total_chat_acceptances: 57 - total_chat_turns: 426 - total_active_chat_users: 8 - breakdown: - - language: python - editor: vscode - suggestions_count: 300 - acceptances_count: 200 - lines_suggested: 600 - lines_accepted: 300 - active_users: 2 - - language: python - editor: jetbrains - suggestions_count: 300 - acceptances_count: 150 - lines_suggested: 300 - lines_accepted: 250 - active_users: 6 - - language: ruby - editor: vscode - suggestions_count: 200 - acceptances_count: 150 - lines_suggested: 200 - lines_accepted: 150 - active_users: 3 public-events-items: value: - id: '22249084947' @@ -203530,6 +205555,20 @@ components: public_members_url: https://api.github.com/orgs/github/public_members{/member} avatar_url: https://github.com/images/error/octocat_happy.gif description: A great organization + billing-usage-report: + value: + usageItems: + - date: '2023-08-01' + product: Actions + sku: Actions Linux + quantity: 100 + unitType: minutes + pricePerUnit: 0.008 + grossAmount: 0.8 + discountAmount: 0 + netAmount: 0.8 + organizationName: GitHub + repositoryName: github/example organization-full: value: login: github @@ -204712,88 +206751,6 @@ components: html_url: https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1326 created_at: '2024-05-10T00:00:00Z' updated_at: '2024-05-10T00:00:00Z' - code-security-configuration: - value: - id: 1325 - target_type: organization - name: octo-org recommended settings - description: This is a code security configuration for octo-org - advanced_security: enabled - dependency_graph: enabled - dependency_graph_autosubmit_action: enabled - dependency_graph_autosubmit_action_options: - labeled_runners: false - dependabot_alerts: enabled - dependabot_security_updates: not_set - code_scanning_default_setup: disabled - secret_scanning: enabled - secret_scanning_push_protection: disabled - secret_scanning_delegated_bypass: disabled - secret_scanning_validity_checks: disabled - secret_scanning_non_provider_patterns: disabled - private_vulnerability_reporting: disabled - enforcement: enforced - url: https://api.github.com/orgs/octo-org/code-security/configurations/1325 - html_url: https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325 - created_at: '2024-05-01T00:00:00Z' - updated_at: '2024-05-01T00:00:00Z' - code-security-default-configurations: - value: - - default_for_new_repos: public - configuration: - id: 1325 - target_type: organization - name: octo-org recommended settings - description: This is a code security configuration for octo-org - advanced_security: enabled - dependency_graph: enabled - dependency_graph_autosubmit_action: not_set - dependency_graph_autosubmit_action_options: - labeled_runners: false - dependabot_alerts: enabled - dependabot_security_updates: not_set - code_scanning_default_setup: enabled - secret_scanning: enabled - secret_scanning_push_protection: enabled - secret_scanning_delegated_bypass: enabled - secret_scanning_delegated_bypass_options: - reviewers: - - security_configuration_id: 1325 - reviewer_id: 5678 - reviewer_type: TEAM - secret_scanning_validity_checks: enabled - secret_scanning_non_provider_patterns: enabled - private_vulnerability_reporting: enabled - enforcement: enforced - url: https://api.github.com/orgs/octo-org/code-security/configurations/1325 - html_url: https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325 - created_at: '2024-05-01T00:00:00Z' - updated_at: '2024-05-01T00:00:00Z' - - default_for_new_repos: private_and_internal - configuration: - id: 17 - target_type: global - name: GitHub recommended - description: Suggested settings for Dependabot, secret scanning, and code - scanning. - advanced_security: enabled - dependency_graph: enabled - dependency_graph_autosubmit_action: not_set - dependency_graph_autosubmit_action_options: - labeled_runners: false - dependabot_alerts: enabled - dependabot_security_updates: not_set - code_scanning_default_setup: enabled - secret_scanning: enabled - secret_scanning_push_protection: enabled - secret_scanning_delegated_bypass: disabled - secret_scanning_validity_checks: disabled - private_vulnerability_reporting: enabled - enforcement: enforced - url: https://api.github.com/orgs/octo-org/code-security/configurations/17 - html_url: https://github.com/organizations/octo-org/settings/security_products/configurations/view - created_at: '2023-12-04T15:58:07Z' - updated_at: '2023-12-04T15:58:07Z' code-security-configuration-updated: value: id: 1325 @@ -204808,6 +206765,9 @@ components: dependabot_alerts: enabled dependabot_security_updates: not_set code_scanning_default_setup: enabled + code_scanning_default_setup_options: + runner_type: not_set + runner_label: secret_scanning: disabled secret_scanning_push_protection: disabled secret_scanning_delegated_bypass: disabled @@ -204819,74 +206779,6 @@ components: html_url: https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325 created_at: '2024-05-01T00:00:00Z' updated_at: '2024-05-01T00:00:00Z' - simple-repository: - value: - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: Hello-World - full_name: octocat/Hello-World - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - private: false - html_url: https://github.com/octocat/Hello-World - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World - archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads - events_url: https://api.github.com/repos/octocat/Hello-World/events - forks_url: https://api.github.com/repos/octocat/Hello-World/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - git_url: git:github.com/octocat/Hello-World.git - issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} - keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} - languages_url: https://api.github.com/repos/octocat/Hello-World/languages - merges_url: https://api.github.com/repos/octocat/Hello-World/merges - milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} - releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} - ssh_url: git@github.com:octocat/Hello-World.git - stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers - statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers - subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription - tags_url: https://api.github.com/repos/octocat/Hello-World/tags - teams_url: https://api.github.com/repos/octocat/Hello-World/teams - trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - hooks_url: http://api.github.com/repos/octocat/Hello-World/hooks codespaces-list: value: total_count: 3 @@ -205333,6 +207225,236 @@ components: cli: enabled public_code_suggestions: block plan_type: business + copilot-seats-list: + value: + total_seats: 2 + seats: + - created_at: '2021-08-03T18:00:00-06:00' + updated_at: '2021-09-23T15:00:00-06:00' + pending_cancellation_date: + last_activity_at: '2021-10-14T00:53:32-06:00' + last_activity_editor: vscode/1.77.3/copilot/1.86.82 + plan_type: business + assignee: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + assigning_team: + id: 1 + node_id: MDQ6VGVhbTE= + url: https://api.github.com/teams/1 + html_url: https://github.com/orgs/github/teams/justice-league + name: Justice League + slug: justice-league + description: A great team. + privacy: closed + notification_setting: notifications_enabled + permission: admin + members_url: https://api.github.com/teams/1/members{/member} + repositories_url: https://api.github.com/teams/1/repos + parent: + - created_at: '2021-09-23T18:00:00-06:00' + updated_at: '2021-09-23T15:00:00-06:00' + pending_cancellation_date: '2021-11-01' + last_activity_at: '2021-10-13T00:53:32-06:00' + last_activity_editor: vscode/1.77.3/copilot/1.86.82 + assignee: + login: octokitten + id: 1 + node_id: MDQ76VNlcjE= + avatar_url: https://github.com/images/error/octokitten_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octokitten + html_url: https://github.com/octokitten + followers_url: https://api.github.com/users/octokitten/followers + following_url: https://api.github.com/users/octokitten/following{/other_user} + gists_url: https://api.github.com/users/octokitten/gists{/gist_id} + starred_url: https://api.github.com/users/octokitten/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octokitten/subscriptions + organizations_url: https://api.github.com/users/octokitten/orgs + repos_url: https://api.github.com/users/octokitten/repos + events_url: https://api.github.com/users/octokitten/events{/privacy} + received_events_url: https://api.github.com/users/octokitten/received_events + type: User + site_admin: false + copilot-usage-metrics-for-day: + value: + - date: '2024-06-24' + total_active_users: 24 + total_engaged_users: 20 + copilot_ide_code_completions: + total_engaged_users: 20 + languages: + - name: python + total_engaged_users: 10 + - name: ruby + total_engaged_users: 10 + editors: + - name: vscode + total_engaged_users: 13 + models: + - name: default + is_custom_model: false + custom_model_training_date: + total_engaged_users: 13 + languages: + - name: python + total_engaged_users: 6 + total_code_suggestions: 249 + total_code_acceptances: 123 + total_code_lines_suggested: 225 + total_code_lines_accepted: 135 + - name: ruby + total_engaged_users: 7 + total_code_suggestions: 496 + total_code_acceptances: 253 + total_code_lines_suggested: 520 + total_code_lines_accepted: 270 + - name: neovim + total_engaged_users: 7 + models: + - name: a-custom-model + is_custom_model: true + custom_model_training_date: '2024-02-01' + languages: + - name: typescript + total_engaged_users: 3 + total_code_suggestions: 112 + total_code_acceptances: 56 + total_code_lines_suggested: 143 + total_code_lines_accepted: 61 + - name: go + total_engaged_users: 4 + total_code_suggestions: 132 + total_code_acceptances: 67 + total_code_lines_suggested: 154 + total_code_lines_accepted: 72 + copilot_ide_chat: + total_engaged_users: 13 + editors: + - name: vscode + total_engaged_users: 13 + models: + - name: default + is_custom_model: false + custom_model_training_date: + total_engaged_users: 12 + total_chats: 45 + total_chat_insertion_events: 12 + total_chat_copy_events: 16 + - name: a-custom-model + is_custom_model: true + custom_model_training_date: '2024-02-01' + total_engaged_users: 1 + total_chats: 10 + total_chat_insertion_events: 11 + total_chat_copy_events: 3 + copilot_dotcom_chat: + total_engaged_users: 14 + models: + - name: default + is_custom_model: false + custom_model_training_date: + total_engaged_users: 14 + total_chats: 38 + copilot_dotcom_pull_requests: + total_engaged_users: 12 + repositories: + - name: demo/repo1 + total_engaged_users: 8 + models: + - name: default + is_custom_model: false + custom_model_training_date: + total_pr_summaries_created: 6 + total_engaged_users: 8 + - name: demo/repo2 + total_engaged_users: 4 + models: + - name: a-custom-model + is_custom_model: true + custom_model_training_date: '2024-02-01' + total_pr_summaries_created: 10 + total_engaged_users: 4 + copilot-usage-metrics-org: + value: + - day: '2023-10-15' + total_suggestions_count: 1000 + total_acceptances_count: 800 + total_lines_suggested: 1800 + total_lines_accepted: 1200 + total_active_users: 10 + total_chat_acceptances: 32 + total_chat_turns: 200 + total_active_chat_users: 4 + breakdown: + - language: python + editor: vscode + suggestions_count: 300 + acceptances_count: 250 + lines_suggested: 900 + lines_accepted: 700 + active_users: 5 + - language: python + editor: jetbrains + suggestions_count: 300 + acceptances_count: 200 + lines_suggested: 400 + lines_accepted: 300 + active_users: 2 + - language: ruby + editor: vscode + suggestions_count: 400 + acceptances_count: 350 + lines_suggested: 500 + lines_accepted: 200 + active_users: 3 + - day: '2023-10-16' + total_suggestions_count: 800 + total_acceptances_count: 600 + total_lines_suggested: 1100 + total_lines_accepted: 700 + total_active_users: 12 + total_chat_acceptances: 57 + total_chat_turns: 426 + total_active_chat_users: 8 + breakdown: + - language: python + editor: vscode + suggestions_count: 300 + acceptances_count: 200 + lines_suggested: 600 + lines_accepted: 300 + active_users: 2 + - language: python + editor: jetbrains + suggestions_count: 300 + acceptances_count: 150 + lines_suggested: 300 + lines_accepted: 250 + active_users: 6 + - language: ruby + editor: vscode + suggestions_count: 200 + acceptances_count: 150 + lines_suggested: 200 + lines_accepted: 150 + active_users: 3 organization-dependabot-secret-paginated: value: total_count: 3 @@ -206748,6 +208870,39 @@ components: token_expired: false token_expires_at: '2023-11-16T08:47:09.000-07:00' token_last_used_at: + org-private-registry-configurations-paginated: + value: + total_count: 1 + configurations: + - name: MAVEN_REPOSITORY_SECRET + registry_type: maven_repository + username: monalisa + created_at: '2019-08-10T14:59:22Z' + updated_at: '2020-01-10T14:59:22Z' + visibility: selected + org-private-registry-configuration: + value: + name: MAVEN_REPOSITORY_SECRET + registry_type: maven_repository + username: monalisa + visibility: private + created_at: '2019-08-10T14:59:22Z' + updated_at: '2020-01-10T14:59:22Z' + org-private-registry-configuration-with-selected-repositories: + value: + name: MAVEN_REPOSITORY_SECRET + registry_type: maven_repository + username: monalisa + visibility: selected + selected_repository_ids: + - 1296269 + - 1296280 + created_at: '2019-08-10T14:59:22Z' + updated_at: '2020-01-10T14:59:22Z' + private-registries-public-key: + value: + key_id: '012345678912345678' + key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 project-items: value: - owner_url: https://api.github.com/orgs/octocat @@ -206820,6 +208975,7 @@ components: value: - property_name: environment url: https://api.github.com/orgs/github/properties/schema/environment + source_type: organization value_type: single_select required: true default_value: production @@ -206830,15 +208986,18 @@ components: values_editable_by: org_actors - property_name: service url: https://api.github.com/orgs/github/properties/schema/service + source_type: organization value_type: string - property_name: team url: https://api.github.com/orgs/github/properties/schema/team + source_type: organization value_type: string description: Team owning the repository custom-property: value: property_name: environment url: https://api.github.com/orgs/github/properties/schema/environment + source_type: organization value_type: single_select required: true default_value: production @@ -208661,6 +210820,11 @@ components: used: 0 remaining: 10 reset: 1691591091 + code_scanning_autofix: + limit: 10 + used: 0 + remaining: 10 + reset: 1691591091 rate: limit: 5000 used: 1 @@ -210206,6 +212370,7 @@ components: reason: unsigned signature: payload: + verified_at: url: https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d html_url: https://github.com/octocat/Hello-World/commit/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d comments_url: https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d/comments @@ -210711,6 +212876,7 @@ components: reason: unsigned signature: payload: + verified_at: comment_count: 0 author: gravatar_id: '' @@ -211848,6 +214014,29 @@ components: classifications: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances + code-scanning-autofix: + value: + status: success + description: This fixes an XSS vulnerability by escaping the user input. + started_at: '2024-02-14T12:29:18Z' + code-scanning-bad-request: + value: + message: The alert_number is not valid + documentation_url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert + status: '400' + code-scanning-autofix-pending: + value: + status: pending + description: + started_at: '2024-02-14T12:29:18Z' + code-scanning-autofix-commits: + value: + target_ref: refs/heads/fix-bug + message: "Let's fix this \U0001FAB2!" + code-scanning-autofix-commits-response: + value: + target_ref: refs/heads/main + sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 code-scanning-alert-instances: value: - ref: refs/heads/main @@ -212983,6 +215172,7 @@ components: reason: unsigned signature: payload: + verified_at: author: login: octocat id: 1 @@ -213536,6 +215726,7 @@ components: reason: unsigned signature: payload: + verified_at: author: login: octocat id: 1 @@ -213958,6 +216149,7 @@ components: reason: unsigned signature: payload: + verified_at: author: login: octocat id: 1 @@ -214025,6 +216217,7 @@ components: reason: unsigned signature: payload: + verified_at: author: login: octocat id: 1 @@ -214096,6 +216289,7 @@ components: reason: unsigned signature: payload: + verified_at: author: login: octocat id: 1 @@ -214318,6 +216512,7 @@ components: reason: unsigned signature: payload: + verified_at: file-commit-example-for-creating-a-file: value: content: @@ -214360,6 +216555,7 @@ components: reason: unsigned signature: payload: + verified_at: file-commit: value: content: @@ -214389,6 +216585,7 @@ components: reason: unsigned signature: payload: + verified_at: contributor-items-response-if-repository-contains-content: value: - login: octocat @@ -215428,6 +217625,7 @@ components: reason: unsigned signature: payload: + verified_at: html_url: https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd git-commit-2: value: @@ -215456,6 +217654,7 @@ components: reason: unsigned signature: payload: + verified_at: git-ref-items: value: - ref: refs/heads/feature-a @@ -215501,6 +217700,7 @@ components: reason: unsigned signature: payload: + verified_at: git-tree: value: sha: cd8274d15fa3ae2ab983129fb037999f264ba9a7 @@ -219575,6 +221775,28 @@ components: site_admin: true push_protection_bypassed: true push_protection_bypassed_at: '2020-11-06T21:48:51Z' + push_protection_bypass_request_reviewer: + login: octocat + id: 3 + node_id: MDQ6VXNlcjI= + avatar_url: https://alambic.github.com/avatars/u/3? + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: true + push_protection_bypass_request_reviewer_comment: Example response + push_protection_bypass_request_comment: Example comment + push_protection_bypass_request_html_url: https://github.com/owner/repo/secret_scanning_exemptions/1 resolution_comment: Example comment validity: inactive publicly_leaked: false @@ -219594,6 +221816,10 @@ components: push_protection_bypassed_by: push_protection_bypassed: false push_protection_bypassed_at: + push_protection_bypass_request_reviewer: + push_protection_bypass_request_reviewer_comment: + push_protection_bypass_request_comment: + push_protection_bypass_request_html_url: resolution_comment: validity: unknown publicly_leaked: false @@ -219615,6 +221841,10 @@ components: push_protection_bypassed_by: push_protection_bypassed: false push_protection_bypassed_at: + push_protection_bypass_request_reviewer: + push_protection_bypass_request_reviewer_comment: + push_protection_bypass_request_comment: + push_protection_bypass_request_html_url: resolution_comment: validity: unknown publicly_leaked: false @@ -219654,6 +221884,10 @@ components: push_protection_bypassed: false push_protection_bypassed_by: push_protection_bypassed_at: + push_protection_bypass_request_reviewer: + push_protection_bypass_request_reviewer_comment: + push_protection_bypass_request_comment: + push_protection_bypass_request_html_url: resolution_comment: Example comment validity: unknown publicly_leaked: false @@ -219702,7 +221936,7 @@ components: discussion_comment_url: https://github.com/community/community/discussions/39082#discussioncomment-4158232 - type: pull_request_title details: - pull_request_title_url: https://api.github.com/repos/octocat/Hello-World/pull/2846 + pull_request_title_url: https://api.github.com/repos/octocat/Hello-World/pulls/2846 - type: pull_request_body details: pull_request_body_url: https://api.github.com/repos/octocat/Hello-World/pulls/2846 @@ -219720,6 +221954,43 @@ components: reason: will_fix_later expire_at: '2020-11-06T18:18:30Z' token_type: mailchimp_api_key + secret-scanning-scan-history: + value: + incremental_scans: + - type: git + status: completed + completed_at: '2024-10-07T02:47:00Z' + backfill_scans: + - type: git + status: completed + started_at: '2024-10-07T02:47:00Z' + completed_at: '2024-10-07T02:50:00Z' + - type: issue + status: completed + started_at: '2024-10-07T02:47:00Z' + completed_at: '2024-10-07T02:49:00Z' + - type: discussion + status: completed + started_at: '2024-10-07T02:47:00Z' + completed_at: '2024-10-07T02:48:00Z' + pattern_update_scans: + - type: discussion + status: in_progress + started_at: '2024-10-07T02:47:00Z' + completed_at: '2024-10-07T02:51:00Z' + custom_pattern_backfill_scans: + - type: git + status: completed + started_at: '2024-10-07T02:47:00Z' + completed_at: '2024-10-07T02:55:00Z' + pattern_slug: my-custom-pattern + pattern_scope: enterprise + - type: git + status: completed + started_at: '2024-10-07T02:47:00Z' + completed_at: '2024-10-07T02:55:00Z' + pattern_slug: my-custom-pattern + pattern_scope: organization repository-advisory: value: ghsa_id: GHSA-abcd-1234-efgh @@ -225529,6 +227800,13 @@ components: required: true schema: type: string + configuration-id: + name: configuration_id + description: The unique identifier of the code security configuration. + in: path + required: true + schema: + type: integer dependabot-alert-comma-separated-states: name: state in: query @@ -225625,9 +227903,9 @@ components: secret-scanning-alert-secret-type: name: secret_type in: query - description: |- - A comma-separated list of secret types to return. By default all secret types are returned. - See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" + description: A comma-separated list of secret types to return. All default secret + patterns are returned. To return experimental patterns, pass the token name(s) + in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. required: false schema: @@ -225680,20 +227958,6 @@ components: schema: type: boolean default: false - enterprise-team-slug: - name: team_slug - description: The slug of the enterprise team name. - in: path - required: true - schema: - type: string - team-slug: - name: team_slug - description: The slug of the team name. - in: path - required: true - schema: - type: string gist-id: name: gist_id description: The unique identifier of the gist. @@ -225807,6 +228071,39 @@ components: required: true schema: type: string + billing-usage-report-year: + name: year + description: If specified, only return results for a single year. The value + of `year` is an integer with four digits representing a year. For example, + `2024`. Default value is the current year. + in: query + required: false + schema: + type: integer + billing-usage-report-month: + name: month + description: If specified, only return results for a single month. The value + of `month` is an integer between `1` and `12`. + in: query + required: false + schema: + type: integer + billing-usage-report-day: + name: day + description: If specified, only return results for a single day. The value of + `day` is an integer between `1` and `31`. + in: query + required: false + schema: + type: integer + billing-usage-report-hour: + name: hour + description: If specified, only return results for a single hour. The value + of `hour` is an integer between `0` and `23`. + in: query + required: false + schema: + type: integer repository-id: name: repository_id description: The unique identifier of the repository. @@ -225890,13 +228187,6 @@ components: required: false schema: "$ref": "#/components/schemas/code-scanning-analysis-tool-guid" - configuration-id: - name: configuration_id - description: The unique identifier of the code security configuration. - in: path - required: true - schema: - type: integer hook-id: name: hook_id description: The unique identifier of the hook. You can find this value in the @@ -225913,11 +228203,11 @@ components: schema: type: string enum: - - installations - - classic_pats - - fine_grained_pats - - oauth_apps - - github_apps_user_to_server + - installation + - classic_pat + - fine_grained_pat + - oauth_app + - github_app_user_to_server api-insights-actor-id: name: actor_id in: path @@ -225927,16 +228217,19 @@ components: type: integer api-insights-min-timestamp: name: min_timestamp - description: The minimum timestamp to query for stats + description: 'The minimum timestamp to query for stats. This is a timestamp + in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: true schema: type: string api-insights-max-timestamp: name: max_timestamp - description: The maximum timestamp to query for stats + description: 'The maximum timestamp to query for stats. Defaults to the time + 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + format: `YYYY-MM-DDTHH:MM:SSZ`.' in: query - required: true + required: false schema: type: string api-insights-route-stats-sort: @@ -225956,6 +228249,14 @@ components: - api_route - total_request_count default: total_request_count + api-insights-api-route-substring: + name: api_route_substring + in: query + description: Providing a substring will filter results where the API route contains + the substring. This is a case-insensitive search. + required: false + schema: + type: string api-insights-sort: name: sort description: The property to sort the results by. @@ -225972,6 +228273,14 @@ components: - subject_name - total_request_count default: total_request_count + api-insights-subject-name-substring: + name: subject_name_substring + in: query + description: Providing a substring will filter results where the subject name + contains the substring. This is a case-insensitive search. + required: false + schema: + type: string api-insights-user-id: name: user_id in: path @@ -225987,6 +228296,14 @@ components: required: true schema: type: string + api-insights-actor-name-substring: + name: actor_name_substring + in: query + description: Providing a substring will filter results where the actor name + contains the substring. This is a case-insensitive search. + required: false + schema: + type: string invitation-id: name: invitation_id description: The unique identifier of the invitation. @@ -226015,6 +228332,13 @@ components: required: true schema: type: string + team-slug: + name: team_slug + description: The slug of the team name. + in: path + required: true + schema: + type: string role-id: name: role_id description: The unique identifier of the role. @@ -226167,11 +228491,10 @@ components: x-multi-segment: true repository-name-in-query: name: repository_name - description: The name of the repository to filter on. When specified, only rule - evaluations from this repository will be returned. + description: The name of the repository to filter on. in: query schema: - type: integer + type: string time-period: name: time_period description: |- @@ -226858,19 +229181,14 @@ components: application/json: schema: "$ref": "#/components/schemas/basic-error" - internal_error: - description: Internal Error - content: - application/json: - schema: - "$ref": "#/components/schemas/basic-error" - usage_metrics_api_disabled: - description: Copilot Usage Merics API setting is disabled at the organization - or enterprise level. + conflict: + description: Conflict content: application/json: schema: "$ref": "#/components/schemas/basic-error" + no_content: + description: A header with no content is returned. service_unavailable: description: Service unavailable content: @@ -226912,8 +229230,17 @@ components: application/json: schema: "$ref": "#/components/schemas/basic-error" - conflict: - description: Conflict + billing_usage_report_org: + description: Billing usage report response for an organization + content: + application/json: + schema: + "$ref": "#/components/schemas/billing-usage-report" + examples: + default: + "$ref": "#/components/examples/billing-usage-report" + internal_error: + description: Internal Error content: application/json: schema: @@ -226974,8 +229301,13 @@ components: examples: default: "$ref": "#/components/examples/runner-labels-readonly" - no_content: - description: A header with no content is returned. + usage_metrics_api_disabled: + description: Copilot Usage Merics API setting is disabled at the organization + or enterprise level. + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" package_es_list_error: description: The value of `per_page` multiplied by `page` cannot be greater than 10000. @@ -227004,6 +229336,22 @@ components: application/json: schema: "$ref": "#/components/schemas/basic-error" + code_scanning_bad_request: + description: Bad Request + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" + examples: + default: + "$ref": "#/components/examples/code-scanning-bad-request" + code_scanning_autofix_create_forbidden: + description: Response if the repository is archived, if GitHub Advanced Security + is not enabled for this repository or if rate limit is exceeded + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" found: description: Found code_scanning_conflict: diff --git a/packages/openapi-typescript/examples/github-api-required.ts b/packages/openapi-typescript/examples/github-api-required.ts index 140ff6084..f562f0873 100644 --- a/packages/openapi-typescript/examples/github-api-required.ts +++ b/packages/openapi-typescript/examples/github-api-required.ts @@ -289,8 +289,6 @@ export interface paths { * * Optionally, use the `permissions` body parameter to specify the permissions that the installation access token should have. If `permissions` is not specified, the installation access token will have all of the permissions that were granted to the app. The installation access token cannot be granted permissions that the app was not granted. * - * When using the repository or permission parameters to reduce the access of the token, the complexity of the token is increased due to both the number of permissions in the request and the number of repositories the token will have access to. If the complexity is too large, the token will fail to be issued. If this occurs, the error message will indicate the maximum number of repositories that should be requested. For the average application requesting 8 permissions, this limit is around 5000 repositories. With fewer permissions requested, more repositories are supported. - * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ post: operations["apps/create-installation-access-token"]; @@ -602,7 +600,7 @@ export interface paths { patch?: never; trace?: never; }; - "/enterprises/{enterprise}/copilot/billing/seats": { + "/enterprises/{enterprise}/code-security/configurations": { parameters: { query?: never; header?: never; @@ -610,33 +608,31 @@ export interface paths { cookie?: never; }; /** - * List all Copilot seat assignments for an enterprise - * @description > [!NOTE] - * > This endpoint is in public preview and is subject to change. + * Get code security configurations for an enterprise + * @description Lists all code security configurations available in an enterprise. * - * Lists all Copilot seats currently being billed for across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription. + * The authenticated user must be an administrator of the enterprise in order to use this endpoint. * - * Users with access through multiple organizations or enterprise teams will only be counted toward `total_seats` once. - * - * For each organization or enterprise team which grants Copilot access to a user, a seat detail object will appear in the `seats` array. - * Each seat object contains information about the assigned user's most recent Copilot activity. Users must have - * telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. For more information about activity data, - * see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." + * OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. + */ + get: operations["code-security/get-configurations-for-enterprise"]; + put?: never; + /** + * Create a code security configuration for an enterprise + * @description Creates a code security configuration in an enterprise. * - * Only enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams. + * The authenticated user must be an administrator of the enterprise in order to use this endpoint. * - * Personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ - get: operations["copilot/list-copilot-seats-for-enterprise"]; - put?: never; - post?: never; + post: operations["code-security/create-configuration-for-enterprise"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/enterprises/{enterprise}/copilot/metrics": { + "/enterprises/{enterprise}/code-security/configurations/defaults": { parameters: { query?: never; header?: never; @@ -644,19 +640,14 @@ export interface paths { cookie?: never; }; /** - * Get Copilot metrics for an enterprise - * @description Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. - * - * The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, - * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, - * they must have telemetry enabled in their IDE. + * Get default code security configurations for an enterprise + * @description Lists the default code security configurations for an enterprise. * - * To access this endpoint, the Copilot Metrics API access policy must be enabled or set to "no policy" for the enterprise within GitHub settings. - * Only enterprise owners and billing managers can view Copilot metrics for the enterprise. + * The authenticated user must be an administrator of the enterprise in order to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. */ - get: operations["copilot/copilot-metrics-for-enterprise"]; + get: operations["code-security/get-default-configurations-for-enterprise"]; put?: never; post?: never; delete?: never; @@ -665,7 +656,7 @@ export interface paths { patch?: never; trace?: never; }; - "/enterprises/{enterprise}/copilot/usage": { + "/enterprises/{enterprise}/code-security/configurations/{configuration_id}": { parameters: { query?: never; header?: never; @@ -673,52 +664,85 @@ export interface paths { cookie?: never; }; /** - * Get a summary of Copilot usage for enterprise members - * @description > [!NOTE] - * > This endpoint is in public preview and is subject to change. + * Retrieve a code security configuration of an enterprise + * @description Gets a code security configuration available in an enterprise. * - * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE - * for all users across organizations with access to Copilot within your enterprise, with a further breakdown of suggestions, acceptances, - * and number of active users by editor and language for each day. See the response schema tab for detailed metrics definitions. + * The authenticated user must be an administrator of the enterprise in order to use this endpoint. * - * The response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day, - * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, - * they must have telemetry enabled in their IDE. + * OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. + */ + get: operations["code-security/get-single-configuration-for-enterprise"]; + put?: never; + post?: never; + /** + * Delete a code security configuration for an enterprise + * @description Deletes a code security configuration from an enterprise. + * Repositories attached to the configuration will retain their settings but will no longer be associated with + * the configuration. + * + * The authenticated user must be an administrator for the enterprise to use this endpoint. * - * The time zone in the response is in UTC time, that means that the cutoff time for the "day" is UTC time. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + */ + delete: operations["code-security/delete-configuration-for-enterprise"]; + options?: never; + head?: never; + /** + * Update a custom code security configuration for an enterprise + * @description Updates a code security configuration in an enterprise. * - * Only owners and billing managers can view Copilot usage metrics for the enterprise. + * The authenticated user must be an administrator of the enterprise in order to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ - get: operations["copilot/usage-metrics-for-enterprise"]; + patch: operations["code-security/update-enterprise-configuration"]; + trace?: never; + }; + "/enterprises/{enterprise}/code-security/configurations/{configuration_id}/attach": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; put?: never; - post?: never; + /** + * Attach an enterprise configuration to repositories + * @description Attaches an enterprise code security configuration to repositories. If the repositories specified are already attached to a configuration, they will be re-attached to the provided configuration. + * + * If insufficient GHAS licenses are available to attach the configuration to a repository, only free features will be enabled. + * + * The authenticated user must be an administrator for the enterprise to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + */ + post: operations["code-security/attach-enterprise-configuration"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/enterprises/{enterprise}/dependabot/alerts": { + "/enterprises/{enterprise}/code-security/configurations/{configuration_id}/defaults": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; + get?: never; /** - * List Dependabot alerts for an enterprise - * @description Lists Dependabot alerts for repositories that are owned by the specified enterprise. + * Set a code security configuration as a default for an enterprise + * @description Sets a code security configuration as a default to be applied to new repositories in your enterprise. * - * The authenticated user must be a member of the enterprise to use this endpoint. + * This configuration will be applied by default to the matching repository type when created, but only for organizations within the enterprise that do not already have a default code security configuration set. * - * Alerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager. For more information about security managers, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * The authenticated user must be an administrator for the enterprise to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ - get: operations["dependabot/list-alerts-for-enterprise"]; - put?: never; + put: operations["code-security/set-configuration-as-default-for-enterprise"]; post?: never; delete?: never; options?: never; @@ -726,7 +750,7 @@ export interface paths { patch?: never; trace?: never; }; - "/enterprises/{enterprise}/secret-scanning/alerts": { + "/enterprises/{enterprise}/code-security/configurations/{configuration_id}/repositories": { parameters: { query?: never; header?: never; @@ -734,16 +758,14 @@ export interface paths { cookie?: never; }; /** - * List secret scanning alerts for an enterprise - * @description Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest. - * - * Alerts are only returned for organizations in the enterprise for which the authenticated user is an organization owner or a [security manager](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization). + * Get repositories associated with an enterprise code security configuration + * @description Lists the repositories associated with an enterprise code security configuration in an organization. * - * The authenticated user must be a member of the enterprise in order to use this endpoint. + * The authenticated user must be an administrator of the enterprise in order to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope or `security_events` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. */ - get: operations["secret-scanning/list-alerts-for-enterprise"]; + get: operations["code-security/get-repositories-for-enterprise-configuration"]; put?: never; post?: never; delete?: never; @@ -752,7 +774,7 @@ export interface paths { patch?: never; trace?: never; }; - "/enterprises/{enterprise}/team/{team_slug}/copilot/metrics": { + "/enterprises/{enterprise}/dependabot/alerts": { parameters: { query?: never; header?: never; @@ -760,22 +782,16 @@ export interface paths { cookie?: never; }; /** - * Get Copilot metrics for an enterprise team - * @description Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. - * - * The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, - * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, - * they must have telemetry enabled in their IDE. + * List Dependabot alerts for an enterprise + * @description Lists Dependabot alerts for repositories that are owned by the specified enterprise. * - * > [!NOTE] - * > This endpoint will only return results for a given day if the enterprise team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day. + * The authenticated user must be a member of the enterprise to use this endpoint. * - * To access this endpoint, the Copilot Metrics API access policy must be enabled or set to "no policy" for the enterprise within GitHub settings. - * Only owners and billing managers for the enterprise that contains the enterprise team can view Copilot metrics for the enterprise team. + * Alerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager. For more information about security managers, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. */ - get: operations["copilot/copilot-metrics-for-enterprise-team"]; + get: operations["dependabot/list-alerts-for-enterprise"]; put?: never; post?: never; delete?: never; @@ -784,7 +800,7 @@ export interface paths { patch?: never; trace?: never; }; - "/enterprises/{enterprise}/team/{team_slug}/copilot/usage": { + "/enterprises/{enterprise}/secret-scanning/alerts": { parameters: { query?: never; header?: never; @@ -792,26 +808,16 @@ export interface paths { cookie?: never; }; /** - * Get a summary of Copilot usage for an enterprise team - * @description > [!NOTE] - * > This endpoint is in public preview and is subject to change. - * - * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE - * for users within an enterprise team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day. - * See the response schema tab for detailed metrics definitions. - * - * The response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day, - * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, - * they must have telemetry enabled in their IDE. + * List secret scanning alerts for an enterprise + * @description Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest. * - * > [!NOTE] - * > This endpoint will only return results for a given day if the enterprise team had five or more members with active Copilot licenses, as evaluated at the end of that day. + * Alerts are only returned for organizations in the enterprise for which the authenticated user is an organization owner or a [security manager](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization). * - * Owners and billing managers for the enterprise that contains the enterprise team can view Copilot usage metrics for the enterprise team. + * The authenticated user must be a member of the enterprise in order to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope or `security_events` scope to use this endpoint. */ - get: operations["copilot/usage-metrics-for-enterprise-team"]; + get: operations["secret-scanning/list-alerts-for-enterprise"]; put?: never; post?: never; delete?: never; @@ -1637,6 +1643,28 @@ export interface paths { patch?: never; trace?: never; }; + "/organizations/{org}/settings/billing/usage": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get billing usage report for an organization + * @description Gets a report of the total usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account. + * + * **Note:** This endpoint is only available to organizations with access to the enhanced billing platform. For more information, see "[About the enhanced billing platform](https://docs.github.com/billing/using-the-new-billing-platform)." + */ + get: operations["billing/get-github-billing-usage-report-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/orgs/{org}": { parameters: { query?: never; @@ -3217,13 +3245,11 @@ export interface paths { * Purchases a GitHub Copilot seat for all users within each specified team. * The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." * - * Only organization owners can add Copilot seats for their organization members. - * - * In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy. + * Only organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy. * For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." * For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." * - * The response will contain the total number of new seats that were created and existing seats that were refreshed. + * The response contains the total number of new seats that were created and existing seats that were refreshed. * * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. */ @@ -3235,14 +3261,11 @@ export interface paths { * * Sets seats for all members of each team specified to "pending cancellation". * This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team. - * - * For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." - * - * For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." + * For more information about disabling access to Copilot, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." * * Only organization owners can cancel Copilot seats for their organization members. * - * The response will contain the total number of seats set to "pending cancellation". + * The response contains the total number of seats set to "pending cancellation". * * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. */ @@ -3269,13 +3292,11 @@ export interface paths { * Purchases a GitHub Copilot seat for each user specified. * The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." * - * Only organization owners can add Copilot seats for their organization members. - * - * In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy. + * Only organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy. * For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." * For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." * - * The response will contain the total number of new seats that were created and existing seats that were refreshed. + * The response contains the total number of new seats that were created and existing seats that were refreshed. * * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. */ @@ -3287,14 +3308,11 @@ export interface paths { * * Sets seats for all users specified to "pending cancellation". * This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership. - * - * For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." - * - * For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." + * For more information about disabling access to Copilot, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." * * Only organization owners can cancel Copilot seats for their organization members. * - * The response will contain the total number of seats set to "pending cancellation". + * The response contains the total number of seats set to "pending cancellation". * * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. */ @@ -3609,7 +3627,9 @@ export interface paths { }; /** * List organization webhooks - * @description You must be an organization owner to use this endpoint. + * @description List webhooks for an organization. + * + * The authenticated user must be an organization owner to use this endpoint. * * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. @@ -3654,7 +3674,9 @@ export interface paths { post?: never; /** * Delete an organization webhook - * @description You must be an organization owner to use this endpoint. + * @description Delete a webhook for an organization. + * + * The authenticated user must be an organization owner to use this endpoint. * * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. @@ -5027,6 +5049,109 @@ export interface paths { patch?: never; trace?: never; }; + "/orgs/{org}/private-registries": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List private registries for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Lists all private registry configurations available at the organization-level without revealing their encrypted + * values. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + get: operations["private-registries/list-org-private-registries"]; + put?: never; + /** + * Create a private registry for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Creates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + post: operations["private-registries/create-org-private-registry"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/private-registries/public-key": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get private registries public key for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Gets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets. + * + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + get: operations["private-registries/get-org-public-key"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/private-registries/{secret_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get a private registry for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Get the configuration of a single private registry defined for an organization, omitting its encrypted value. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + get: operations["private-registries/get-org-private-registry"]; + put?: never; + post?: never; + /** + * Delete a private registry for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Delete a private registry configuration at the organization-level. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + delete: operations["private-registries/delete-org-private-registry"]; + options?: never; + head?: never; + /** + * Update a private registry for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + patch: operations["private-registries/update-org-private-registry"]; + trace?: never; + }; "/orgs/{org}/projects": { parameters: { query?: never; @@ -5384,11 +5509,9 @@ export interface paths { }; /** * List security manager teams - * @description Lists teams that are security managers for an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." - * - * The authenticated user must be an administrator or security manager for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the "[Organization Roles](https://docs.github.com/rest/orgs/organization-roles)" endpoints instead. */ get: operations["orgs/list-security-manager-teams"]; put?: never; @@ -5409,21 +5532,17 @@ export interface paths { get?: never; /** * Add a security manager team - * @description Adds a team as a security manager for an organization. For more information, see "[Managing security for an organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) for an organization." - * - * The authenticated user must be an administrator for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the "[Organization Roles](https://docs.github.com/rest/orgs/organization-roles)" endpoints instead. */ put: operations["orgs/add-security-manager-team"]; post?: never; /** * Remove a security manager team - * @description Removes the security manager role from a team for an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) team from an organization." - * - * The authenticated user must be an administrator for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the "[Organization Roles](https://docs.github.com/rest/orgs/organization-roles)" endpoints instead. */ delete: operations["orgs/remove-security-manager-team"]; options?: never; @@ -7166,7 +7285,7 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. * - * This API will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`. + * This endpoint will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`. */ get: operations["actions/list-workflow-runs-for-repo"]; put?: never; @@ -7871,6 +7990,8 @@ export interface paths { * Anyone with read access to the repository can use this endpoint * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * + * This endpoint will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`. */ get: operations["actions/list-workflow-runs"]; put?: never; @@ -8806,6 +8927,62 @@ export interface paths { patch: operations["code-scanning/update-alert"]; trace?: never; }; + "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/autofix": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get the status of an autofix for a code scanning alert + * @description Gets the status and description of an autofix for a code scanning alert. + * + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + */ + get: operations["code-scanning/get-autofix"]; + put?: never; + /** + * Create an autofix for a code scanning alert + * @description Creates an autofix for a code scanning alert. + * + * If a new autofix is to be created as a result of this request or is currently being generated, then this endpoint will return a 202 Accepted response. + * + * If an autofix already exists for a given alert, then this endpoint will return a 200 OK response. + * + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + */ + post: operations["code-scanning/create-autofix"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/autofix/commits": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Commit an autofix for a code scanning alert + * @description Commits an autofix for a code scanning alert. + * + * If an autofix is commited as a result of this request, then this endpoint will return a 201 Created response. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + */ + post: operations["code-scanning/commit-autofix"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances": { parameters: { query?: never; @@ -9700,6 +9877,7 @@ export interface paths { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -9842,6 +10020,7 @@ export interface paths { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -10042,6 +10221,7 @@ export interface paths { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -11026,6 +11206,7 @@ export interface paths { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -11075,6 +11256,7 @@ export interface paths { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -11220,6 +11402,7 @@ export interface paths { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -11265,6 +11448,7 @@ export interface paths { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -11381,7 +11565,12 @@ export interface paths { get: operations["repos/get-webhook"]; put?: never; post?: never; - /** Delete a repository webhook */ + /** + * Delete a repository webhook + * @description Delete a webhook for an organization. + * + * The authenticated user must be a repository owner, or have admin access in the repository, to delete the webhook. + */ delete: operations["repos/delete-webhook"]; options?: never; head?: never; @@ -12288,6 +12477,96 @@ export interface paths { patch?: never; trace?: never; }; + "/repos/{owner}/{repo}/issues/{issue_number}/sub_issue": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + /** + * Remove sub-issue + * @description You can use the REST API to remove a sub-issue from an issue. + * Removing content too quickly using this endpoint may result in secondary rate limiting. + * For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass a specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + */ + delete: operations["issues/remove-sub-issue"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/issues/{issue_number}/sub_issues": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List sub-issues + * @description You can use the REST API to list the sub-issues on an issue. + * + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + */ + get: operations["issues/list-sub-issues"]; + put?: never; + /** + * Add sub-issue + * @description You can use the REST API to add sub-issues to issues. + * + * Creating content too quickly using this endpoint may result in secondary rate limiting. + * For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + * + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + */ + post: operations["issues/add-sub-issue"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/issues/{issue_number}/sub_issues/priority": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + /** + * Reprioritize sub-issue + * @description You can use the REST API to reprioritize a sub-issue to a different position in the parent list. + */ + patch: operations["issues/reprioritize-sub-issue"]; + trace?: never; + }; "/repos/{owner}/{repo}/issues/{issue_number}/timeline": { parameters: { query?: never; @@ -13586,7 +13865,13 @@ export interface paths { }; /** * Get a release asset - * @description To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response. + * @description To download the asset's binary content: + * + * - If within a browser, fetch the location specified in the `browser_download_url` key provided in the response. + * - Alternatively, set the `Accept` header of the request to + * [`application/octet-stream`](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + * The API will either redirect the client to the location, or stream it directly if possible. + * API clients should handle both a `200` or `302` response. */ get: operations["repos/get-release-asset"]; put?: never; @@ -14005,6 +14290,28 @@ export interface paths { patch?: never; trace?: never; }; + "/repos/{owner}/{repo}/secret-scanning/scan-history": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get secret scanning scan history for a repository + * @description Lists the latest incremental and backfill scans by type for a repository. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + */ + get: operations["secret-scanning/get-scan-history"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/repos/{owner}/{repo}/security-advisories": { parameters: { query?: never; @@ -19792,567 +20099,192 @@ export interface components { /** Format: uri */ html_url: string | null; }; - /** - * Organization Simple - * @description A GitHub organization. - */ - "nullable-organization-simple": { - /** @example github */ - login: string; - /** @example 1 */ + /** @description A code security configuration */ + "code-security-configuration": { + /** @description The ID of the code security configuration */ id: number; - /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ - node_id: string; + /** @description The name of the code security configuration. Must be unique within the organization. */ + name: string; /** - * Format: uri - * @example https://api.github.com/orgs/github + * @description The type of the code security configuration. + * @enum {string} */ - url: string; + target_type: "global" | "organization" | "enterprise"; + /** @description A description of the code security configuration */ + description: string; /** - * Format: uri - * @example https://api.github.com/orgs/github/repos + * @description The enablement status of GitHub Advanced Security + * @enum {string} */ - repos_url: string; + advanced_security: "enabled" | "disabled"; /** - * Format: uri - * @example https://api.github.com/orgs/github/events + * @description The enablement status of Dependency Graph + * @enum {string} */ - events_url: string; - /** @example https://api.github.com/orgs/github/hooks */ - hooks_url: string; - /** @example https://api.github.com/orgs/github/issues */ - issues_url: string; - /** @example https://api.github.com/orgs/github/members{/member} */ - members_url: string; - /** @example https://api.github.com/orgs/github/public_members{/member} */ - public_members_url: string; - /** @example https://github.com/images/error/octocat_happy.gif */ - avatar_url: string; - /** @example A great organization */ - description: string | null; - } | null; - /** - * Team Simple - * @description Groups of organization members that gives permissions on specified repositories. - */ - "nullable-team-simple": { + dependency_graph: "enabled" | "disabled" | "not_set"; /** - * @description Unique identifier of the team - * @example 1 + * @description The enablement status of Automatic dependency submission + * @enum {string} */ - id: number; - /** @example MDQ6VGVhbTE= */ - node_id: string; + dependency_graph_autosubmit_action: "enabled" | "disabled" | "not_set"; + /** @description Feature options for Automatic dependency submission */ + dependency_graph_autosubmit_action_options: { + /** @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. */ + labeled_runners: boolean; + }; /** - * Format: uri - * @description URL for the team - * @example https://api.github.com/organizations/1/team/1 + * @description The enablement status of Dependabot alerts + * @enum {string} */ - url: string; - /** @example https://api.github.com/organizations/1/team/1/members{/member} */ - members_url: string; + dependabot_alerts: "enabled" | "disabled" | "not_set"; /** - * @description Name of the team - * @example Justice League + * @description The enablement status of Dependabot security updates + * @enum {string} */ - name: string; + dependabot_security_updates: "enabled" | "disabled" | "not_set"; /** - * @description Description of the team - * @example A great team. + * @description The enablement status of code scanning default setup + * @enum {string} */ - description: string | null; + code_scanning_default_setup: "enabled" | "disabled" | "not_set"; + /** @description Feature options for code scanning default setup */ + code_scanning_default_setup_options: { + /** + * @description Whether to use labeled runners or standard GitHub runners. + * @enum {string|null} + */ + runner_type: "standard" | "labeled" | "not_set" | null; + /** @description The label of the runner to use for code scanning when runner_type is 'labeled'. */ + runner_label: string | null; + } | null; /** - * @description Permission that the team will have for its repositories - * @example admin + * @description The enablement status of secret scanning + * @enum {string} */ - permission: string; + secret_scanning: "enabled" | "disabled" | "not_set"; /** - * @description The level of privacy this team should have - * @example closed + * @description The enablement status of secret scanning push protection + * @enum {string} */ - privacy?: string; + secret_scanning_push_protection: "enabled" | "disabled" | "not_set"; /** - * @description The notification setting the team has set - * @example notifications_enabled + * @description The enablement status of secret scanning delegated bypass + * @enum {string} */ - notification_setting?: string; + secret_scanning_delegated_bypass: "enabled" | "disabled" | "not_set"; + /** @description Feature options for secret scanning delegated bypass */ + secret_scanning_delegated_bypass_options: { + /** @description The bypass reviewers for secret scanning delegated bypass */ + reviewers: { + /** @description The ID of the team or role selected as a bypass reviewer */ + reviewer_id: number; + /** + * @description The type of the bypass reviewer + * @enum {string} + */ + reviewer_type: "TEAM" | "ROLE"; + }[]; + }; /** - * Format: uri - * @example https://github.com/orgs/rails/teams/core + * @description The enablement status of secret scanning validity checks + * @enum {string} */ - html_url: string; + secret_scanning_validity_checks: "enabled" | "disabled" | "not_set"; /** - * Format: uri - * @example https://api.github.com/organizations/1/team/1/repos + * @description The enablement status of secret scanning non-provider patterns + * @enum {string} */ - repositories_url: string; - /** @example justice-league */ - slug: string; + secret_scanning_non_provider_patterns: "enabled" | "disabled" | "not_set"; /** - * @description Distinguished Name (DN) that team maps to within LDAP environment - * @example uid=example,ou=users,dc=github,dc=com + * @description The enablement status of private vulnerability reporting + * @enum {string} */ - ldap_dn?: string; - } | null; - /** - * Team - * @description Groups of organization members that gives permissions on specified repositories. - */ - team: { - id: number; - node_id: string; - name: string; - slug: string; - description: string | null; - privacy?: string; - notification_setting?: string; - permission: string; - permissions?: { - pull: boolean; - triage: boolean; - push: boolean; - maintain: boolean; - admin: boolean; - }; - /** Format: uri */ - url: string; + private_vulnerability_reporting: "enabled" | "disabled" | "not_set"; + /** + * @description The enforcement status for a security configuration + * @enum {string} + */ + enforcement: "enforced" | "unenforced"; /** * Format: uri - * @example https://github.com/orgs/rails/teams/core + * @description The URL of the configuration */ - html_url: string; - members_url: string; - /** Format: uri */ - repositories_url: string; - parent: components["schemas"]["nullable-team-simple"]; - }; - /** - * Enterprise Team - * @description Group of enterprise owners and/or members - */ - "enterprise-team": { - /** Format: int64 */ - id: number; - name: string; - slug: string; - /** Format: uri */ url: string; - /** @example disabled | all */ - sync_to_organizations: string; - /** @example 62ab9291-fae2-468e-974b-7e45096d5021 */ - group_id?: string | null; /** * Format: uri - * @example https://github.com/enterprises/dc/teams/justice-league + * @description The URL of the configuration */ html_url: string; - members_url: string; /** Format: date-time */ created_at: string; /** Format: date-time */ updated_at: string; }; + /** @description Feature options for code scanning default setup */ + "code-scanning-default-setup-options": { + /** + * @description Whether to use labeled runners or standard GitHub runners. + * @enum {string} + */ + runner_type: "standard" | "labeled" | "not_set"; + /** @description The label of the runner to use for code scanning default setup when runner_type is 'labeled'. */ + runner_label: string | null; + } | null; + /** @description A list of default code security configurations */ + "code-security-default-configurations": { + /** + * @description The visibility of newly created repositories for which the code security configuration will be applied to by default + * @enum {unknown} + */ + default_for_new_repos: "public" | "private_and_internal" | "all"; + configuration: components["schemas"]["code-security-configuration"]; + }[]; /** - * Copilot Business Seat Detail - * @description Information about a Copilot Business seat assignment for a user, team, or organization. + * Simple Repository + * @description A GitHub repository. */ - "copilot-seat-details": { - assignee: components["schemas"]["simple-user"]; - organization?: components["schemas"]["nullable-organization-simple"]; - /** @description The team through which the assignee is granted access to GitHub Copilot, if applicable. */ - assigning_team?: (components["schemas"]["team"] | components["schemas"]["enterprise-team"]) | null; + "simple-repository": { /** - * Format: date - * @description The pending cancellation date for the seat, in `YYYY-MM-DD` format. This will be null unless the assignee's Copilot access has been canceled during the current billing cycle. If the seat has been cancelled, this corresponds to the start of the organization's next billing cycle. + * Format: int64 + * @description A unique identifier of the repository. + * @example 1296269 */ - pending_cancellation_date?: string | null; + id: number; /** - * Format: date-time - * @description Timestamp of user's last GitHub Copilot activity, in ISO 8601 format. + * @description The GraphQL identifier of the repository. + * @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ - last_activity_at?: string | null; - /** @description Last editor that was used by the user for a GitHub Copilot completion. */ - last_activity_editor?: string | null; + node_id: string; /** - * Format: date-time - * @description Timestamp of when the assignee was last granted access to GitHub Copilot, in ISO 8601 format. + * @description The name of the repository. + * @example Hello-World */ - created_at: string; + name: string; /** - * Format: date-time - * @description Timestamp of when the assignee's GitHub Copilot access was last updated, in ISO 8601 format. + * @description The full, globally unique, name of the repository. + * @example octocat/Hello-World */ - updated_at?: string; + full_name: string; + owner: components["schemas"]["simple-user"]; + /** @description Whether the repository is private. */ + private: boolean; /** - * @description The Copilot plan of the organization, or the parent enterprise, when applicable. - * @enum {string} + * Format: uri + * @description The URL to view the repository on GitHub.com. + * @example https://github.com/octocat/Hello-World */ - plan_type?: "business" | "enterprise" | "unknown"; - }; - /** @description Usage metrics for Copilot editor code completions in the IDE. */ - "copilot-ide-code-completions": ({ - /** @description Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances. */ - total_engaged_users: number; - /** @description Code completion metrics for active languages. */ - languages: { - /** @description Name of the language used for Copilot code completion suggestions. */ - name: string; - /** @description Number of users who accepted at least one Copilot code completion suggestion for the given language. Includes both full and partial acceptances. */ - total_engaged_users: number; - }[]; - editors: ({ - /** @description Name of the given editor. */ - name: string; - /** @description Number of users who accepted at least one Copilot code completion suggestion for the given editor. Includes both full and partial acceptances. */ - total_engaged_users: number; - /** @description List of model metrics for custom models and the default model. */ - models: { - /** @description Name of the language used for Copilot code completion suggestions, for the given editor. */ - name: string; - /** @description Indicates whether a model is custom or default. */ - is_custom_model: boolean; - /** @description The training date for the custom model. */ - custom_model_training_date: string | null; - /** @description Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances. */ - total_engaged_users: number; - /** @description Code completion metrics for active languages, for the given editor. */ - languages: { - /** @description Name of the language used for Copilot code completion suggestions, for the given editor. */ - name: string; - /** @description Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language. Includes both full and partial acceptances. */ - total_engaged_users: number; - /** @description The number of Copilot code suggestions generated for the given editor, for the given language. */ - total_code_suggestions: number; - /** @description The number of Copilot code suggestions accepted for the given editor, for the given language. Includes both full and partial acceptances. */ - total_code_acceptances: number; - /** @description The number of lines of code suggested by Copilot code completions for the given editor, for the given language. */ - total_code_lines_suggested: number; - /** @description The number of lines of code accepted from Copilot code suggestions for the given editor, for the given language. */ - total_code_lines_accepted: number; - }[]; - }[]; - } & { - [key: string]: unknown; - })[]; - } & { - [key: string]: unknown; - }) | null; - /** @description Usage metrics for Copilot Chat in the IDE. */ - "copilot-ide-chat": ({ - /** @description Total number of users who prompted Copilot Chat in the IDE. */ - total_engaged_users: number; - editors: { - /** @description Name of the given editor. */ - name: string; - /** @description The number of users who prompted Copilot Chat in the specified editor. */ - total_engaged_users: number; - /** @description List of model metrics for custom models and the default model. */ - models: { - /** @description Name of the language used for Copilot code completion suggestions, for the given editor. */ - name: string; - /** @description Indicates whether a model is custom or default. */ - is_custom_model: boolean; - /** @description The training date for the custom model. */ - custom_model_training_date: string | null; - /** @description The number of users who prompted Copilot Chat in the given editor and model. */ - total_engaged_users: number; - /** @description The total number of chats initiated by users in the given editor and model. */ - total_chats: number; - /** @description The number of times users accepted a code suggestion from Copilot Chat using the 'Insert Code' UI element, for the given editor. */ - total_chat_insertion_events: number; - /** @description The number of times users copied a code suggestion from Copilot Chat using the keyboard, or the 'Copy' UI element, for the given editor. */ - total_chat_copy_events: number; - }[]; - }[]; - } & { - [key: string]: unknown; - }) | null; - /** @description Usage metrics for Copilot Chat in github.com */ - "copilot-dotcom-chat": ({ - /** @description Total number of users who prompted Copilot Chat on github.com at least once. */ - total_engaged_users: number; - /** @description List of model metrics for a custom models and the default model. */ - models: { - /** @description Name of the language used for Copilot code completion suggestions, for the given editor. */ - name: string; - /** @description Indicates whether a model is custom or default. */ - is_custom_model: boolean; - /** @description The training date for the custom model (if applicable). */ - custom_model_training_date: string | null; - /** @description Total number of users who prompted Copilot Chat on github.com at least once for each model. */ - total_engaged_users: number; - /** @description Total number of chats initiated by users on github.com. */ - total_chats: number; - }[]; - } & { - [key: string]: unknown; - }) | null; - /** @description Usage metrics for Copilot for pull requests. */ - "copilot-dotcom-pull-requests": ({ - /** @description The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once. */ - total_engaged_users: number; - /** @description Repositories in which users used Copilot for Pull Requests to generate pull request summaries */ - repositories: { - /** @description Repository name */ - name: string; - /** @description The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository. */ - total_engaged_users: number; - /** @description List of model metrics for custom models and the default model. */ - models: { - /** @description Name of the language used for Copilot code completion suggestions, for the given editor. */ - name: string; - /** @description Indicates whether a model is custom or default. */ - is_custom_model: boolean; - /** @description The training date for the custom model. */ - custom_model_training_date: string | null; - /** @description The number of pull request summaries generated using Copilot for Pull Requests in the given repository. */ - total_pr_summaries_created: number; - /** @description The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository and model. */ - total_engaged_users: number; - }[]; - }[]; - } & { - [key: string]: unknown; - }) | null; - /** - * Copilot Usage Metrics - * @description Copilot usage metrics for a given day. - */ - "copilot-usage-metrics-day": { + html_url: string; /** - * Format: date - * @description The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format. + * @description The repository description. + * @example This your first repo! */ - date: string; - /** @description The total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint. */ - total_active_users?: number; - /** @description The total number of Copilot users who engaged with any Copilot feature, for the given day. Examples include but are not limited to accepting a code suggestion, prompting Copilot chat, or triggering a PR Summary. Does not include authentication events. Is not limited to the individual features detailed on the endpoint. */ - total_engaged_users?: number; - copilot_ide_code_completions?: components["schemas"]["copilot-ide-code-completions"]; - copilot_ide_chat?: components["schemas"]["copilot-ide-chat"]; - copilot_dotcom_chat?: components["schemas"]["copilot-dotcom-chat"]; - copilot_dotcom_pull_requests?: components["schemas"]["copilot-dotcom-pull-requests"]; - } & { - [key: string]: unknown; - }; - /** - * Copilot Usage Metrics - * @description Summary of Copilot usage. - */ - "copilot-usage-metrics": { + description: string | null; + /** @description Whether the repository is a fork. */ + fork: boolean; /** - * Format: date - * @description The date for which the usage metrics are reported, in `YYYY-MM-DD` format. - */ - day: string; - /** @description The total number of Copilot code completion suggestions shown to users. */ - total_suggestions_count?: number; - /** @description The total number of Copilot code completion suggestions accepted by users. */ - total_acceptances_count?: number; - /** @description The total number of lines of code completions suggested by Copilot. */ - total_lines_suggested?: number; - /** @description The total number of lines of code completions accepted by users. */ - total_lines_accepted?: number; - /** @description The total number of users who were shown Copilot code completion suggestions during the day specified. */ - total_active_users?: number; - /** @description The total instances of users who accepted code suggested by Copilot Chat in the IDE (panel and inline). */ - total_chat_acceptances?: number; - /** @description The total number of chat turns (prompt and response pairs) sent between users and Copilot Chat in the IDE. */ - total_chat_turns?: number; - /** @description The total number of users who interacted with Copilot Chat in the IDE during the day specified. */ - total_active_chat_users?: number; - /** @description Breakdown of Copilot code completions usage by language and editor */ - breakdown: ({ - /** @description The language in which Copilot suggestions were shown to users in the specified editor. */ - language: string; - /** @description The editor in which Copilot suggestions were shown to users for the specified language. */ - editor: string; - /** @description The number of Copilot suggestions shown to users in the editor specified during the day specified. */ - suggestions_count: number; - /** @description The number of Copilot suggestions accepted by users in the editor specified during the day specified. */ - acceptances_count: number; - /** @description The number of lines of code suggested by Copilot in the editor specified during the day specified. */ - lines_suggested: number; - /** @description The number of lines of code accepted by users in the editor specified during the day specified. */ - lines_accepted: number; - /** @description The number of users who were shown Copilot completion suggestions in the editor specified during the day specified. */ - active_users: number; - } & { - [key: string]: unknown; - })[] | null; - }; - /** @description The security alert number. */ - "alert-number": number; - /** @description Details for the vulnerable package. */ - "dependabot-alert-package": { - /** @description The package's language or package management ecosystem. */ - readonly ecosystem: string; - /** @description The unique package name within its ecosystem. */ - readonly name: string; - }; - /** @description Details pertaining to one vulnerable version range for the advisory. */ - "dependabot-alert-security-vulnerability": { - package: components["schemas"]["dependabot-alert-package"]; - /** - * @description The severity of the vulnerability. - * @enum {string} - */ - readonly severity: "low" | "medium" | "high" | "critical"; - /** @description Conditions that identify vulnerable versions of this vulnerability's package. */ - readonly vulnerable_version_range: string; - /** @description Details pertaining to the package version that patches this vulnerability. */ - readonly first_patched_version: { - /** @description The package version that patches this vulnerability. */ - readonly identifier: string; - } | null; - }; - /** @description Details for the GitHub Security Advisory. */ - "dependabot-alert-security-advisory": { - /** @description The unique GitHub Security Advisory ID assigned to the advisory. */ - readonly ghsa_id: string; - /** @description The unique CVE ID assigned to the advisory. */ - readonly cve_id: string | null; - /** @description A short, plain text summary of the advisory. */ - readonly summary: string; - /** @description A long-form Markdown-supported description of the advisory. */ - readonly description: string; - /** @description Vulnerable version range information for the advisory. */ - readonly vulnerabilities: components["schemas"]["dependabot-alert-security-vulnerability"][]; - /** - * @description The severity of the advisory. - * @enum {string} - */ - readonly severity: "low" | "medium" | "high" | "critical"; - /** @description Details for the advisory pertaining to the Common Vulnerability Scoring System. */ - readonly cvss: { - /** @description The overall CVSS score of the advisory. */ - readonly score: number; - /** @description The full CVSS vector string for the advisory. */ - readonly vector_string: string | null; - }; - cvss_severities?: components["schemas"]["cvss-severities"]; - /** @description Details for the advisory pertaining to Common Weakness Enumeration. */ - readonly cwes: { - /** @description The unique CWE ID. */ - readonly cwe_id: string; - /** @description The short, plain text name of the CWE. */ - readonly name: string; - }[]; - /** @description Values that identify this advisory among security information sources. */ - readonly identifiers: { - /** - * @description The type of advisory identifier. - * @enum {string} - */ - readonly type: "CVE" | "GHSA"; - /** @description The value of the advisory identifer. */ - readonly value: string; - }[]; - /** @description Links to additional advisory information. */ - readonly references: { - /** - * Format: uri - * @description The URL of the reference. - */ - readonly url: string; - }[]; - /** - * Format: date-time - * @description The time that the advisory was published in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. - */ - readonly published_at: string; - /** - * Format: date-time - * @description The time that the advisory was last modified in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. - */ - readonly updated_at: string; - /** - * Format: date-time - * @description The time that the advisory was withdrawn in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. - */ - readonly withdrawn_at: string | null; - }; - /** - * Format: uri - * @description The REST API URL of the alert resource. - */ - "alert-url": string; - /** - * Format: uri - * @description The GitHub URL of the alert resource. - */ - "alert-html-url": string; - /** - * Format: date-time - * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. - */ - "alert-created-at": string; - /** - * Format: date-time - * @description The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. - */ - "alert-updated-at": string; - /** - * Format: date-time - * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. - */ - "alert-dismissed-at": string | null; - /** - * Format: date-time - * @description The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. - */ - "alert-fixed-at": string | null; - /** - * Format: date-time - * @description The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. - */ - "alert-auto-dismissed-at": string | null; - /** - * Simple Repository - * @description A GitHub repository. - */ - "simple-repository": { - /** - * Format: int64 - * @description A unique identifier of the repository. - * @example 1296269 - */ - id: number; - /** - * @description The GraphQL identifier of the repository. - * @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - */ - node_id: string; - /** - * @description The name of the repository. - * @example Hello-World - */ - name: string; - /** - * @description The full, globally unique, name of the repository. - * @example octocat/Hello-World - */ - full_name: string; - owner: components["schemas"]["simple-user"]; - /** @description Whether the repository is private. */ - private: boolean; - /** - * Format: uri - * @description The URL to view the repository on GitHub.com. - * @example https://github.com/octocat/Hello-World - */ - html_url: string; - /** - * @description The repository description. - * @example This your first repo! - */ - description: string | null; - /** @description Whether the repository is a fork. */ - fork: boolean; - /** - * Format: uri - * @description The URL to get more information about the repository from the GitHub API. - * @example https://api.github.com/repos/octocat/Hello-World + * Format: uri + * @description The URL to get more information about the repository from the GitHub API. + * @example https://api.github.com/repos/octocat/Hello-World */ url: string; /** @@ -20549,6 +20481,141 @@ export interface components { */ hooks_url: string; }; + /** @description Repositories associated with a code security configuration and attachment status */ + "code-security-configuration-repositories": { + /** + * @description The attachment status of the code security configuration on the repository. + * @enum {string} + */ + status: "attached" | "attaching" | "detached" | "removed" | "enforced" | "failed" | "updating" | "removed_by_enterprise"; + repository: components["schemas"]["simple-repository"]; + }; + /** @description The security alert number. */ + "alert-number": number; + /** @description Details for the vulnerable package. */ + "dependabot-alert-package": { + /** @description The package's language or package management ecosystem. */ + readonly ecosystem: string; + /** @description The unique package name within its ecosystem. */ + readonly name: string; + }; + /** @description Details pertaining to one vulnerable version range for the advisory. */ + "dependabot-alert-security-vulnerability": { + package: components["schemas"]["dependabot-alert-package"]; + /** + * @description The severity of the vulnerability. + * @enum {string} + */ + readonly severity: "low" | "medium" | "high" | "critical"; + /** @description Conditions that identify vulnerable versions of this vulnerability's package. */ + readonly vulnerable_version_range: string; + /** @description Details pertaining to the package version that patches this vulnerability. */ + readonly first_patched_version: { + /** @description The package version that patches this vulnerability. */ + readonly identifier: string; + } | null; + }; + /** @description Details for the GitHub Security Advisory. */ + "dependabot-alert-security-advisory": { + /** @description The unique GitHub Security Advisory ID assigned to the advisory. */ + readonly ghsa_id: string; + /** @description The unique CVE ID assigned to the advisory. */ + readonly cve_id: string | null; + /** @description A short, plain text summary of the advisory. */ + readonly summary: string; + /** @description A long-form Markdown-supported description of the advisory. */ + readonly description: string; + /** @description Vulnerable version range information for the advisory. */ + readonly vulnerabilities: components["schemas"]["dependabot-alert-security-vulnerability"][]; + /** + * @description The severity of the advisory. + * @enum {string} + */ + readonly severity: "low" | "medium" | "high" | "critical"; + /** @description Details for the advisory pertaining to the Common Vulnerability Scoring System. */ + readonly cvss: { + /** @description The overall CVSS score of the advisory. */ + readonly score: number; + /** @description The full CVSS vector string for the advisory. */ + readonly vector_string: string | null; + }; + cvss_severities?: components["schemas"]["cvss-severities"]; + /** @description Details for the advisory pertaining to Common Weakness Enumeration. */ + readonly cwes: { + /** @description The unique CWE ID. */ + readonly cwe_id: string; + /** @description The short, plain text name of the CWE. */ + readonly name: string; + }[]; + /** @description Values that identify this advisory among security information sources. */ + readonly identifiers: { + /** + * @description The type of advisory identifier. + * @enum {string} + */ + readonly type: "CVE" | "GHSA"; + /** @description The value of the advisory identifer. */ + readonly value: string; + }[]; + /** @description Links to additional advisory information. */ + readonly references: { + /** + * Format: uri + * @description The URL of the reference. + */ + readonly url: string; + }[]; + /** + * Format: date-time + * @description The time that the advisory was published in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + readonly published_at: string; + /** + * Format: date-time + * @description The time that the advisory was last modified in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + readonly updated_at: string; + /** + * Format: date-time + * @description The time that the advisory was withdrawn in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + readonly withdrawn_at: string | null; + }; + /** + * Format: uri + * @description The REST API URL of the alert resource. + */ + "alert-url": string; + /** + * Format: uri + * @description The GitHub URL of the alert resource. + */ + "alert-html-url": string; + /** + * Format: date-time + * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + "alert-created-at": string; + /** + * Format: date-time + * @description The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + "alert-updated-at": string; + /** + * Format: date-time + * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + "alert-dismissed-at": string | null; + /** + * Format: date-time + * @description The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + "alert-fixed-at": string | null; + /** + * Format: date-time + * @description The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + "alert-auto-dismissed-at": string | null; /** @description A Dependabot alert. */ "dependabot-alert-with-repository": { number: components["schemas"]["alert-number"]; @@ -20637,6 +20704,16 @@ export interface components { * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ push_protection_bypassed_at: string | null; + push_protection_bypass_request_reviewer: components["schemas"]["nullable-simple-user"]; + /** @description An optional comment when reviewing a push protection bypass. */ + push_protection_bypass_request_reviewer_comment: string | null; + /** @description An optional comment when requesting a push protection bypass. */ + push_protection_bypass_request_comment: string | null; + /** + * Format: uri + * @description The URL to a push protection bypass request. + */ + push_protection_bypass_request_html_url: string | null; /** @description The comment that was optionally added when this alert was closed */ resolution_comment: string | null; /** @@ -20836,6 +20913,12 @@ export interface components { eyes: number; rocket: number; }; + /** Sub-issues Summary */ + "sub-issues-summary": { + total: number; + completed: number; + percent_completed: number; + }; /** * Issue * @description Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. @@ -20938,6 +21021,7 @@ export interface components { performed_via_github_app?: components["schemas"]["nullable-integration"]; author_association: components["schemas"]["author-association"]; reactions?: components["schemas"]["reaction-rollup"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; }; /** * Issue Comment @@ -21624,6 +21708,10 @@ export interface components { copilot: string[]; packages: string[]; actions: string[]; + actions_inbound: { + full_domains: string[]; + wildcard_domains: string[]; + }; artifact_attestations: { /** @example [ * "example" @@ -21967,6 +22055,32 @@ export interface components { /** @example A great organization */ description: string | null; }; + "billing-usage-report": { + usageItems: { + /** @description Date of the usage line item. */ + date: string; + /** @description Product name. */ + product: string; + /** @description SKU name. */ + sku: string; + /** @description Quantity of the usage line item. */ + quantity: number; + /** @description Unit type of the usage line item. */ + unitType: string; + /** @description Price per unit of the usage line item. */ + pricePerUnit: number; + /** @description Gross amount of the usage line item. */ + grossAmount: number; + /** @description Discount amount of the usage line item. */ + discountAmount: number; + /** @description Net amount of the usage line item. */ + netAmount: number; + /** @description Name of the organization. */ + organizationName: string; + /** @description Name of the repository. */ + repositoryName?: string; + }[]; + }; /** * Organization Full * @description Organization Full @@ -22588,135 +22702,6 @@ export interface components { most_recent_instance: components["schemas"]["code-scanning-alert-instance"]; repository: components["schemas"]["simple-repository"]; }; - /** @description A code security configuration */ - "code-security-configuration": { - /** @description The ID of the code security configuration */ - id: number; - /** @description The name of the code security configuration. Must be unique within the organization. */ - name: string; - /** - * @description The type of the code security configuration. - * @enum {string} - */ - target_type: "global" | "organization" | "enterprise"; - /** @description A description of the code security configuration */ - description: string; - /** - * @description The enablement status of GitHub Advanced Security - * @enum {string} - */ - advanced_security: "enabled" | "disabled"; - /** - * @description The enablement status of Dependency Graph - * @enum {string} - */ - dependency_graph: "enabled" | "disabled" | "not_set"; - /** - * @description The enablement status of Automatic dependency submission - * @enum {string} - */ - dependency_graph_autosubmit_action: "enabled" | "disabled" | "not_set"; - /** @description Feature options for Automatic dependency submission */ - dependency_graph_autosubmit_action_options: { - /** @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. */ - labeled_runners: boolean; - }; - /** - * @description The enablement status of Dependabot alerts - * @enum {string} - */ - dependabot_alerts: "enabled" | "disabled" | "not_set"; - /** - * @description The enablement status of Dependabot security updates - * @enum {string} - */ - dependabot_security_updates: "enabled" | "disabled" | "not_set"; - /** - * @description The enablement status of code scanning default setup - * @enum {string} - */ - code_scanning_default_setup: "enabled" | "disabled" | "not_set"; - /** - * @description The enablement status of secret scanning - * @enum {string} - */ - secret_scanning: "enabled" | "disabled" | "not_set"; - /** - * @description The enablement status of secret scanning push protection - * @enum {string} - */ - secret_scanning_push_protection: "enabled" | "disabled" | "not_set"; - /** - * @description The enablement status of secret scanning delegated bypass - * @enum {string} - */ - secret_scanning_delegated_bypass: "enabled" | "disabled" | "not_set"; - /** @description Feature options for secret scanning delegated bypass */ - secret_scanning_delegated_bypass_options: { - /** @description The bypass reviewers for secret scanning delegated bypass */ - reviewers: { - /** @description The ID of the team or role selected as a bypass reviewer */ - reviewer_id: number; - /** - * @description The type of the bypass reviewer - * @enum {string} - */ - reviewer_type: "TEAM" | "ROLE"; - }[]; - }; - /** - * @description The enablement status of secret scanning validity checks - * @enum {string} - */ - secret_scanning_validity_checks: "enabled" | "disabled" | "not_set"; - /** - * @description The enablement status of secret scanning non-provider patterns - * @enum {string} - */ - secret_scanning_non_provider_patterns: "enabled" | "disabled" | "not_set"; - /** - * @description The enablement status of private vulnerability reporting - * @enum {string} - */ - private_vulnerability_reporting: "enabled" | "disabled" | "not_set"; - /** - * @description The enforcement status for a security configuration - * @enum {string} - */ - enforcement: "enforced" | "unenforced"; - /** - * Format: uri - * @description The URL of the configuration - */ - url: string; - /** - * Format: uri - * @description The URL of the configuration - */ - html_url: string; - /** Format: date-time */ - created_at: string; - /** Format: date-time */ - updated_at: string; - }; - /** @description A list of default code security configurations */ - "code-security-default-configurations": { - /** - * @description The visibility of newly created repositories for which the code security configuration will be applied to by default - * @enum {unknown} - */ - default_for_new_repos: "public" | "private_and_internal" | "all"; - configuration: components["schemas"]["code-security-configuration"]; - }[]; - /** @description Repositories associated with a code security configuration and attachment status */ - "code-security-configuration-repositories": { - /** - * @description The attachment status of the code security configuration on the repository. - * @enum {string} - */ - status: "attached" | "attaching" | "detached" | "removed" | "enforced" | "failed" | "updating" | "removed_by_enterprise"; - repository: components["schemas"]["simple-repository"]; - }; /** * Codespace machine * @description A description of the machine powering a codespace. @@ -23029,6 +23014,396 @@ export interface components { } & { [key: string]: unknown; }; + /** + * Organization Simple + * @description A GitHub organization. + */ + "nullable-organization-simple": { + /** @example github */ + login: string; + /** @example 1 */ + id: number; + /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ + node_id: string; + /** + * Format: uri + * @example https://api.github.com/orgs/github + */ + url: string; + /** + * Format: uri + * @example https://api.github.com/orgs/github/repos + */ + repos_url: string; + /** + * Format: uri + * @example https://api.github.com/orgs/github/events + */ + events_url: string; + /** @example https://api.github.com/orgs/github/hooks */ + hooks_url: string; + /** @example https://api.github.com/orgs/github/issues */ + issues_url: string; + /** @example https://api.github.com/orgs/github/members{/member} */ + members_url: string; + /** @example https://api.github.com/orgs/github/public_members{/member} */ + public_members_url: string; + /** @example https://github.com/images/error/octocat_happy.gif */ + avatar_url: string; + /** @example A great organization */ + description: string | null; + } | null; + /** + * Team Simple + * @description Groups of organization members that gives permissions on specified repositories. + */ + "nullable-team-simple": { + /** + * @description Unique identifier of the team + * @example 1 + */ + id: number; + /** @example MDQ6VGVhbTE= */ + node_id: string; + /** + * Format: uri + * @description URL for the team + * @example https://api.github.com/organizations/1/team/1 + */ + url: string; + /** @example https://api.github.com/organizations/1/team/1/members{/member} */ + members_url: string; + /** + * @description Name of the team + * @example Justice League + */ + name: string; + /** + * @description Description of the team + * @example A great team. + */ + description: string | null; + /** + * @description Permission that the team will have for its repositories + * @example admin + */ + permission: string; + /** + * @description The level of privacy this team should have + * @example closed + */ + privacy?: string; + /** + * @description The notification setting the team has set + * @example notifications_enabled + */ + notification_setting?: string; + /** + * Format: uri + * @example https://github.com/orgs/rails/teams/core + */ + html_url: string; + /** + * Format: uri + * @example https://api.github.com/organizations/1/team/1/repos + */ + repositories_url: string; + /** @example justice-league */ + slug: string; + /** + * @description Distinguished Name (DN) that team maps to within LDAP environment + * @example uid=example,ou=users,dc=github,dc=com + */ + ldap_dn?: string; + } | null; + /** + * Team + * @description Groups of organization members that gives permissions on specified repositories. + */ + team: { + id: number; + node_id: string; + name: string; + slug: string; + description: string | null; + privacy?: string; + notification_setting?: string; + permission: string; + permissions?: { + pull: boolean; + triage: boolean; + push: boolean; + maintain: boolean; + admin: boolean; + }; + /** Format: uri */ + url: string; + /** + * Format: uri + * @example https://github.com/orgs/rails/teams/core + */ + html_url: string; + members_url: string; + /** Format: uri */ + repositories_url: string; + parent: components["schemas"]["nullable-team-simple"]; + }; + /** + * Enterprise Team + * @description Group of enterprise owners and/or members + */ + "enterprise-team": { + /** Format: int64 */ + id: number; + name: string; + slug: string; + /** Format: uri */ + url: string; + /** @example disabled | all */ + sync_to_organizations: string; + /** @example 62ab9291-fae2-468e-974b-7e45096d5021 */ + group_id?: string | null; + /** + * Format: uri + * @example https://github.com/enterprises/dc/teams/justice-league + */ + html_url: string; + members_url: string; + /** Format: date-time */ + created_at: string; + /** Format: date-time */ + updated_at: string; + }; + /** + * Copilot Business Seat Detail + * @description Information about a Copilot Business seat assignment for a user, team, or organization. + */ + "copilot-seat-details": { + assignee: components["schemas"]["simple-user"]; + organization?: components["schemas"]["nullable-organization-simple"]; + /** @description The team through which the assignee is granted access to GitHub Copilot, if applicable. */ + assigning_team?: (components["schemas"]["team"] | components["schemas"]["enterprise-team"]) | null; + /** + * Format: date + * @description The pending cancellation date for the seat, in `YYYY-MM-DD` format. This will be null unless the assignee's Copilot access has been canceled during the current billing cycle. If the seat has been cancelled, this corresponds to the start of the organization's next billing cycle. + */ + pending_cancellation_date?: string | null; + /** + * Format: date-time + * @description Timestamp of user's last GitHub Copilot activity, in ISO 8601 format. + */ + last_activity_at?: string | null; + /** @description Last editor that was used by the user for a GitHub Copilot completion. */ + last_activity_editor?: string | null; + /** + * Format: date-time + * @description Timestamp of when the assignee was last granted access to GitHub Copilot, in ISO 8601 format. + */ + created_at: string; + /** + * Format: date-time + * @deprecated + * @description **Closing down notice:** This field is no longer relevant and is closing down. Use the `created_at` field to determine when the assignee was last granted access to GitHub Copilot. Timestamp of when the assignee's GitHub Copilot access was last updated, in ISO 8601 format. + */ + updated_at?: string; + /** + * @description The Copilot plan of the organization, or the parent enterprise, when applicable. + * @enum {string} + */ + plan_type?: "business" | "enterprise" | "unknown"; + }; + /** @description Usage metrics for Copilot editor code completions in the IDE. */ + "copilot-ide-code-completions": ({ + /** @description Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances. */ + total_engaged_users: number; + /** @description Code completion metrics for active languages. */ + languages: { + /** @description Name of the language used for Copilot code completion suggestions. */ + name: string; + /** @description Number of users who accepted at least one Copilot code completion suggestion for the given language. Includes both full and partial acceptances. */ + total_engaged_users: number; + }[]; + editors: ({ + /** @description Name of the given editor. */ + name: string; + /** @description Number of users who accepted at least one Copilot code completion suggestion for the given editor. Includes both full and partial acceptances. */ + total_engaged_users: number; + /** @description List of model metrics for custom models and the default model. */ + models: { + /** @description Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'. */ + name: string; + /** @description Indicates whether a model is custom or default. */ + is_custom_model: boolean; + /** @description The training date for the custom model. */ + custom_model_training_date: string | null; + /** @description Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances. */ + total_engaged_users: number; + /** @description Code completion metrics for active languages, for the given editor. */ + languages: { + /** @description Name of the language used for Copilot code completion suggestions, for the given editor. */ + name: string; + /** @description Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language. Includes both full and partial acceptances. */ + total_engaged_users: number; + /** @description The number of Copilot code suggestions generated for the given editor, for the given language. */ + total_code_suggestions: number; + /** @description The number of Copilot code suggestions accepted for the given editor, for the given language. Includes both full and partial acceptances. */ + total_code_acceptances: number; + /** @description The number of lines of code suggested by Copilot code completions for the given editor, for the given language. */ + total_code_lines_suggested: number; + /** @description The number of lines of code accepted from Copilot code suggestions for the given editor, for the given language. */ + total_code_lines_accepted: number; + }[]; + }[]; + } & { + [key: string]: unknown; + })[]; + } & { + [key: string]: unknown; + }) | null; + /** @description Usage metrics for Copilot Chat in the IDE. */ + "copilot-ide-chat": ({ + /** @description Total number of users who prompted Copilot Chat in the IDE. */ + total_engaged_users: number; + editors: { + /** @description Name of the given editor. */ + name: string; + /** @description The number of users who prompted Copilot Chat in the specified editor. */ + total_engaged_users: number; + /** @description List of model metrics for custom models and the default model. */ + models: { + /** @description Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'. */ + name: string; + /** @description Indicates whether a model is custom or default. */ + is_custom_model: boolean; + /** @description The training date for the custom model. */ + custom_model_training_date: string | null; + /** @description The number of users who prompted Copilot Chat in the given editor and model. */ + total_engaged_users: number; + /** @description The total number of chats initiated by users in the given editor and model. */ + total_chats: number; + /** @description The number of times users accepted a code suggestion from Copilot Chat using the 'Insert Code' UI element, for the given editor. */ + total_chat_insertion_events: number; + /** @description The number of times users copied a code suggestion from Copilot Chat using the keyboard, or the 'Copy' UI element, for the given editor. */ + total_chat_copy_events: number; + }[]; + }[]; + } & { + [key: string]: unknown; + }) | null; + /** @description Usage metrics for Copilot Chat in github.com */ + "copilot-dotcom-chat": ({ + /** @description Total number of users who prompted Copilot Chat on github.com at least once. */ + total_engaged_users: number; + /** @description List of model metrics for a custom models and the default model. */ + models: { + /** @description Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'. */ + name: string; + /** @description Indicates whether a model is custom or default. */ + is_custom_model: boolean; + /** @description The training date for the custom model (if applicable). */ + custom_model_training_date: string | null; + /** @description Total number of users who prompted Copilot Chat on github.com at least once for each model. */ + total_engaged_users: number; + /** @description Total number of chats initiated by users on github.com. */ + total_chats: number; + }[]; + } & { + [key: string]: unknown; + }) | null; + /** @description Usage metrics for Copilot for pull requests. */ + "copilot-dotcom-pull-requests": ({ + /** @description The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once. */ + total_engaged_users: number; + /** @description Repositories in which users used Copilot for Pull Requests to generate pull request summaries */ + repositories: { + /** @description Repository name */ + name: string; + /** @description The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository. */ + total_engaged_users: number; + /** @description List of model metrics for custom models and the default model. */ + models: { + /** @description Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'. */ + name: string; + /** @description Indicates whether a model is custom or default. */ + is_custom_model: boolean; + /** @description The training date for the custom model. */ + custom_model_training_date: string | null; + /** @description The number of pull request summaries generated using Copilot for Pull Requests in the given repository. */ + total_pr_summaries_created: number; + /** @description The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository and model. */ + total_engaged_users: number; + }[]; + }[]; + } & { + [key: string]: unknown; + }) | null; + /** + * Copilot Usage Metrics + * @description Copilot usage metrics for a given day. + */ + "copilot-usage-metrics-day": { + /** + * Format: date + * @description The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format. + */ + date: string; + /** @description The total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint. */ + total_active_users?: number; + /** @description The total number of Copilot users who engaged with any Copilot feature, for the given day. Examples include but are not limited to accepting a code suggestion, prompting Copilot chat, or triggering a PR Summary. Does not include authentication events. Is not limited to the individual features detailed on the endpoint. */ + total_engaged_users?: number; + copilot_ide_code_completions?: components["schemas"]["copilot-ide-code-completions"]; + copilot_ide_chat?: components["schemas"]["copilot-ide-chat"]; + copilot_dotcom_chat?: components["schemas"]["copilot-dotcom-chat"]; + copilot_dotcom_pull_requests?: components["schemas"]["copilot-dotcom-pull-requests"]; + } & { + [key: string]: unknown; + }; + /** + * Copilot Usage Metrics + * @description Summary of Copilot usage. + */ + "copilot-usage-metrics": { + /** + * Format: date + * @description The date for which the usage metrics are reported, in `YYYY-MM-DD` format. + */ + day: string; + /** @description The total number of Copilot code completion suggestions shown to users. */ + total_suggestions_count?: number; + /** @description The total number of Copilot code completion suggestions accepted by users. */ + total_acceptances_count?: number; + /** @description The total number of lines of code completions suggested by Copilot. */ + total_lines_suggested?: number; + /** @description The total number of lines of code completions accepted by users. */ + total_lines_accepted?: number; + /** @description The total number of users who were shown Copilot code completion suggestions during the day specified. */ + total_active_users?: number; + /** @description The total instances of users who accepted code suggested by Copilot Chat in the IDE (panel and inline). */ + total_chat_acceptances?: number; + /** @description The total number of chat turns (prompt and response pairs) sent between users and Copilot Chat in the IDE. */ + total_chat_turns?: number; + /** @description The total number of users who interacted with Copilot Chat in the IDE during the day specified. */ + total_active_chat_users?: number; + /** @description Breakdown of Copilot code completions usage by language and editor */ + breakdown: ({ + /** @description The language in which Copilot suggestions were shown to users in the specified editor. */ + language: string; + /** @description The editor in which Copilot suggestions were shown to users for the specified language. */ + editor: string; + /** @description The number of Copilot suggestions shown to users in the editor specified during the day specified. */ + suggestions_count: number; + /** @description The number of Copilot suggestions accepted by users in the editor specified during the day specified. */ + acceptances_count: number; + /** @description The number of lines of code suggested by Copilot in the editor specified during the day specified. */ + lines_suggested: number; + /** @description The number of lines of code accepted by users in the editor specified during the day specified. */ + lines_accepted: number; + /** @description The number of users who were shown Copilot completion suggestions in the editor specified during the day specified. */ + active_users: number; + } & { + [key: string]: unknown; + })[] | null; + }; /** * Dependabot Secret for an Organization * @description Secrets for GitHub Dependabot for an organization. @@ -23608,6 +23983,16 @@ export interface components { name: string; /** @description A short description about who this role is for or what permissions it grants. */ description?: string | null; + /** + * @description The system role from which this role inherits permissions. + * @enum {string|null} + */ + base_role?: "read" | "triage" | "write" | "maintain" | "admin" | null; + /** + * @description Source answers the question, "where did this role come from?" + * @enum {string|null} + */ + source?: "Organization" | "Enterprise" | "Predefined" | null; /** @description A list of permissions included in this role. */ permissions: string[]; organization: components["schemas"]["nullable-simple-user"]; @@ -23627,6 +24012,12 @@ export interface components { * @description The Relationship a Team has with a role. */ "team-role-assignment": { + /** + * @description Determines if the team has a direct, indirect, or mixed relationship to a role + * @example direct + * @enum {string} + */ + assignment?: "direct" | "indirect" | "mixed"; id: number; node_id: string; name: string; @@ -23722,6 +24113,14 @@ export interface components { * @description The Relationship a User has with a role. */ "user-role-assignment": { + /** + * @description Determines if the user has a direct, indirect, or mixed relationship to a role + * @example direct + * @enum {string} + */ + assignment?: "direct" | "indirect" | "mixed"; + /** @description Team the user has gotten the role through */ + inherited_from?: components["schemas"]["team-simple"][]; name?: string | null; email?: string | null; /** @example octocat */ @@ -23926,6 +24325,68 @@ export interface components { /** @description Date and time when the associated fine-grained personal access token was last used for authentication. */ token_last_used_at: string | null; }; + /** + * Organization private registry + * @description Private registry configuration for an organization + */ + "org-private-registry-configuration": { + /** + * @description The name of the private registry configuration. + * @example MAVEN_REPOSITORY_SECRET + */ + name: string; + /** + * @description The registry type. + * @enum {string} + */ + registry_type: "maven_repository"; + /** + * @description The username to use when authenticating with the private registry. + * @example monalisa + */ + username?: string | null; + /** + * @description Which type of organization repositories have access to the private registry. + * @enum {string} + */ + visibility: "all" | "private" | "selected"; + /** Format: date-time */ + created_at: string; + /** Format: date-time */ + updated_at: string; + }; + /** + * Organization private registry + * @description Private registry configuration for an organization + */ + "org-private-registry-configuration-with-selected-repositories": { + /** + * @description The name of the private registry configuration. + * @example MAVEN_REPOSITORY_SECRET + */ + name: string; + /** + * @description The registry type. + * @enum {string} + */ + registry_type: "maven_repository"; + /** + * @description The username to use when authenticating with the private registry. + * @example monalisa + */ + username?: string; + /** + * @description Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry. + * @enum {string} + */ + visibility: "all" | "private" | "selected"; + /** @description An array of repository IDs that can access the organization private registry when `visibility` is set to `selected`. */ + selected_repository_ids?: number[]; + /** Format: date-time */ + created_at: string; + /** Format: date-time */ + updated_at: string; + }; /** * Project * @description Projects are a way to organize columns and cards of work. @@ -24003,6 +24464,12 @@ export interface components { * @description The URL that can be used to fetch, update, or delete info about this property via the API. */ url?: string; + /** + * @description The source type of the property + * @example organization + * @enum {string} + */ + source_type?: "organization" | "enterprise"; /** * @description The type of the value for the property * @example single_select @@ -24025,6 +24492,27 @@ export interface components { */ values_editable_by?: "org_actors" | "org_and_repo_actors" | null; }; + /** + * Custom Property Set Payload + * @description Custom property set payload + */ + "custom-property-set-payload": { + /** + * @description The type of the value for the property + * @example single_select + * @enum {string} + */ + value_type: "string" | "single_select" | "multi_select" | "true_false"; + /** @description Whether the property is required. */ + required?: boolean; + /** @description Default value of the property */ + default_value?: (string | string[]) | null; + /** @description Short description of the property */ + description?: string | null; + /** @description An ordered list of the allowed values of the property. + * The property can have up to 200 allowed values. */ + allowed_values?: string[] | null; + }; /** * Custom Property Value * @description Custom property name and associated value @@ -24829,6 +25317,7 @@ export interface components { * @description Conditions for an organization ruleset. * The branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties. * The push rulesets conditions object does not require the `ref_name` property. + * For repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`. */ "org-ruleset-conditions": (components["schemas"]["repository-ruleset-conditions"] & components["schemas"]["repository-ruleset-conditions-repository-name-target"]) | (components["schemas"]["repository-ruleset-conditions"] & components["schemas"]["repository-ruleset-conditions-repository-id-target"]) | (components["schemas"]["repository-ruleset-conditions"] & components["schemas"]["repository-ruleset-conditions-repository-property-target"]); /** @@ -24937,6 +25426,8 @@ export interface components { /** @enum {string} */ type: "pull_request"; parameters?: { + /** @description When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled. */ + allowed_merge_methods?: string[]; /** @description New, reviewable commits pushed will dismiss previous pull request review approvals. */ dismiss_stale_reviews_on_push: boolean; /** @description Require an approving review in pull requests that modify files that have a designated code owner. */ @@ -25202,12 +25693,12 @@ export interface components { * @description The target of the ruleset * @enum {string} */ - target?: "branch" | "tag" | "push"; + target?: "branch" | "tag" | "push" | "repository"; /** * @description The type of the source of the ruleset * @enum {string} */ - source_type?: "Repository" | "Organization"; + source_type?: "Repository" | "Organization" | "Enterprise"; /** @description The name of the source */ source: string; enforcement: components["schemas"]["repository-rule-enforcement"]; @@ -26361,6 +26852,7 @@ export interface components { actions_runner_registration?: components["schemas"]["rate-limit"]; scim?: components["schemas"]["rate-limit"]; dependency_snapshots?: components["schemas"]["rate-limit"]; + code_scanning_autofix?: components["schemas"]["rate-limit"]; }; rate: components["schemas"]["rate-limit"]; }; @@ -27498,6 +27990,7 @@ export interface components { reason: string; payload: string | null; signature: string | null; + verified_at?: string | null; }; /** * Diff Entry @@ -28069,6 +28562,36 @@ export interface components { * @enum {string} */ "code-scanning-alert-set-state": "open" | "dismissed"; + /** + * @description The status of an autofix. + * @enum {string} + */ + "code-scanning-autofix-status": "pending" | "error" | "success" | "outdated"; + /** @description The description of an autofix. */ + "code-scanning-autofix-description": string | null; + /** + * Format: date-time + * @description The start time of an autofix in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + "code-scanning-autofix-started-at": string; + "code-scanning-autofix": { + status: components["schemas"]["code-scanning-autofix-status"]; + description: components["schemas"]["code-scanning-autofix-description"]; + started_at: components["schemas"]["code-scanning-autofix-started-at"]; + }; + /** @description Commit an autofix for a code scanning alert */ + "code-scanning-autofix-commits": { + /** @description The Git reference of target branch for the commit. Branch needs to already exist. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ + target_ref: string; + /** @description Commit message to be used. */ + message: string; + } | null; + "code-scanning-autofix-commits-response": { + /** @description The Git reference of target branch for the commit. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ + target_ref: string; + /** @description SHA of commit with autofix. */ + sha: string; + }; /** * @description An identifier for the upload. * @example 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53 @@ -28298,7 +28821,7 @@ export interface components { */ state: "configured" | "not-configured"; /** @description Languages to be analyzed. */ - languages: ("c-cpp" | "csharp" | "go" | "java-kotlin" | "javascript-typescript" | "javascript" | "python" | "ruby" | "typescript" | "swift")[]; + languages: ("actions" | "c-cpp" | "csharp" | "go" | "java-kotlin" | "javascript-typescript" | "javascript" | "python" | "ruby" | "typescript" | "swift")[]; /** * @description CodeQL query suite to be used. * @enum {string} @@ -28323,13 +28846,23 @@ export interface components { * @enum {string} */ state: "configured" | "not-configured"; + /** + * @description Runner type to be used. + * @enum {string} + */ + runner_type: "standard" | "labeled"; + /** + * @description Runner label to be used if the runner type is labeled. + * @example code-scanning + */ + runner_label: string | null; /** * @description CodeQL query suite to be used. * @enum {string} */ query_suite: "default" | "extended"; /** @description CodeQL languages to be analyzed. */ - languages: ("c-cpp" | "csharp" | "go" | "java-kotlin" | "javascript-typescript" | "python" | "ruby" | "swift")[]; + languages: ("actions" | "c-cpp" | "csharp" | "go" | "java-kotlin" | "javascript-typescript" | "python" | "ruby" | "swift")[]; }; /** @description You can use `run_url` to track the status of the run. This includes a property status and conclusion. * You should not rely on this always being an actions workflow run object. */ @@ -29285,6 +29818,7 @@ export interface components { reason: string; signature: string | null; payload: string | null; + verified_at: string | null; }; }; }; @@ -30039,6 +30573,7 @@ export interface components { reason: string; signature: string | null; payload: string | null; + verified_at?: string | null; }; /** Format: uri */ html_url: string; @@ -30400,6 +30935,7 @@ export interface components { performed_via_github_app?: components["schemas"]["nullable-integration"]; author_association: components["schemas"]["author-association"]; reactions?: components["schemas"]["reaction-rollup"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; } | null; /** * Issue Event Label @@ -30978,6 +31514,7 @@ export interface components { reason: string; signature: string | null; payload: string | null; + verified_at?: string | null; }; /** Format: uri */ html_url: string; @@ -32114,6 +32651,16 @@ export interface components { * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ push_protection_bypassed_at: string | null; + push_protection_bypass_request_reviewer: components["schemas"]["nullable-simple-user"]; + /** @description An optional comment when reviewing a push protection bypass. */ + push_protection_bypass_request_reviewer_comment: string | null; + /** @description An optional comment when requesting a push protection bypass. */ + push_protection_bypass_request_comment: string | null; + /** + * Format: uri + * @description The URL to a push protection bypass request. + */ + push_protection_bypass_request_html_url: string | null; /** * @description The token status as of the latest validity check. * @enum {string} @@ -32251,7 +32798,7 @@ export interface components { /** * Format: uri * @description The API URL to get the pull request where the secret was detected. - * @example https://api.github.com/repos/octocat/Hello-World/pull/2846 + * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846 */ pull_request_title_url: string; }; @@ -32260,7 +32807,7 @@ export interface components { /** * Format: uri * @description The API URL to get the pull request where the secret was detected. - * @example https://api.github.com/repos/octocat/Hello-World/pull/2846 + * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846 */ pull_request_body_url: string; }; @@ -32315,6 +32862,34 @@ export interface components { /** @description The token type this bypass is for. */ token_type: string; }; + /** @description Information on a single scan performed by secret scanning on the repository */ + "secret-scanning-scan": { + /** @description The type of scan */ + type: string; + /** @description The state of the scan. Either "completed", "running", or "pending" */ + status: string; + /** + * Format: date-time + * @description The time that the scan was completed. Empty if the scan is running + */ + completed_at: string | null; + /** + * Format: date-time + * @description The time that the scan was started. Empty if the scan is pending + */ + started_at: string | null; + }; + "secret-scanning-scan-history": { + incremental_scans: components["schemas"]["secret-scanning-scan"][]; + pattern_update_scans: components["schemas"]["secret-scanning-scan"][]; + backfill_scans: components["schemas"]["secret-scanning-scan"][]; + custom_pattern_backfill_scans: (components["schemas"]["secret-scanning-scan"] & { + /** @description Name of the custom pattern for custom pattern scans */ + pattern_name?: string; + /** @description Level at which the custom pattern is defined, one of "repository", "organization", or "enterprise" */ + pattern_scope?: string; + })[]; + }; "repository-advisory-create": { /** @description A short summary of the advisory. */ summary: string; @@ -32749,6 +33324,12 @@ export interface components { default: boolean; description: string | null; }[]; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; state: string; state_reason?: string | null; assignee: components["schemas"]["nullable-simple-user"]; @@ -35340,6 +35921,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -35828,6 +36415,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -38908,6 +39501,16 @@ export interface components { * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ push_protection_bypassed_at: string | null; + push_protection_bypass_request_reviewer: components["schemas"]["nullable-simple-user"]; + /** @description An optional comment when reviewing a push protection bypass. */ + push_protection_bypass_request_reviewer_comment: string | null; + /** @description An optional comment when requesting a push protection bypass. */ + push_protection_bypass_request_comment: string | null; + /** + * Format: uri + * @description The URL to a push protection bypass request. + */ + push_protection_bypass_request_html_url: string | null; /** @description Whether the detected secret was publicly leaked. */ publicly_leaked: boolean | null; /** @description Whether the detected secret was found in multiple repositories in the same organization or business. */ @@ -43992,21 +44595,424 @@ export interface components { * @enum {string} */ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue comment */ - body: string; + /** @description Contents of the issue comment */ + body: string; + /** Format: date-time */ + created_at: string; + /** Format: uri */ + html_url: string; + /** + * Format: int64 + * @description Unique identifier of the issue comment + */ + id: number; + /** Format: uri */ + issue_url: string; + node_id: string; + performed_via_github_app: components["schemas"]["nullable-integration"]; + /** Reactions */ + reactions: { + "+1": number; + "-1": number; + confused: number; + eyes: number; + heart: number; + hooray: number; + laugh: number; + rocket: number; + total_count: number; + /** Format: uri */ + url: string; + }; + /** Format: date-time */ + updated_at: string; + /** + * Format: uri + * @description URL for the issue comment + */ + url: string; + /** User */ + user: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + /** Format: int64 */ + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null; + }; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. */ + issue: { + /** @enum {string|null} */ + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + /** User */ + assignee?: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization" | "Mannequin"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null; + assignees: ({ + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization" | "Mannequin"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null)[]; + /** + * AuthorAssociation + * @description How the author is associated with the repository. + * @enum {string} + */ + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + /** @description Contents of the issue */ + body: string | null; + /** Format: date-time */ + closed_at: string | null; + comments: number; + /** Format: uri */ + comments_url: string; /** Format: date-time */ created_at: string; + draft?: boolean; + /** Format: uri */ + events_url: string; /** Format: uri */ html_url: string; + /** Format: int64 */ + id: number; + labels?: { + /** @description 6-character hex code, without the leading #, identifying the color */ + color: string; + default: boolean; + description: string | null; + id: number; + /** @description The name of the label. */ + name: string; + node_id: string; + /** + * Format: uri + * @description URL for the label + */ + url: string; + }[]; + /** Format: uri-template */ + labels_url: string; + locked?: boolean; /** - * Format: int64 - * @description Unique identifier of the issue comment + * Milestone + * @description A collection of related issues and pull requests. */ - id: number; - /** Format: uri */ - issue_url: string; + milestone: { + /** Format: date-time */ + closed_at: string | null; + closed_issues: number; + /** Format: date-time */ + created_at: string; + /** User */ + creator: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization" | "Mannequin"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null; + description: string | null; + /** Format: date-time */ + due_on: string | null; + /** Format: uri */ + html_url: string; + id: number; + /** Format: uri */ + labels_url: string; + node_id: string; + /** @description The number of the milestone. */ + number: number; + open_issues: number; + /** + * @description The state of the milestone. + * @enum {string} + */ + state: "open" | "closed"; + /** @description The title of the milestone. */ + title: string; + /** Format: date-time */ + updated_at: string; + /** Format: uri */ + url: string; + } | null; node_id: string; - performed_via_github_app: components["schemas"]["nullable-integration"]; + number: number; + /** + * App + * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. + */ + performed_via_github_app?: { + /** Format: date-time */ + created_at: string | null; + description: string | null; + /** @description The list of events for the GitHub app */ + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "pull_request_review_thread")[]; + /** Format: uri */ + external_url: string | null; + /** Format: uri */ + html_url: string; + /** @description Unique identifier of the GitHub app */ + id: number | null; + /** @description The name of the GitHub app */ + name: string; + node_id: string; + /** User */ + owner: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null; + /** @description The set of permissions for the GitHub app */ + permissions?: { + /** @enum {string} */ + actions: "read" | "write"; + /** @enum {string} */ + administration: "read" | "write"; + /** @enum {string} */ + checks: "read" | "write"; + /** @enum {string} */ + content_references: "read" | "write"; + /** @enum {string} */ + contents: "read" | "write"; + /** @enum {string} */ + deployments: "read" | "write"; + /** @enum {string} */ + discussions: "read" | "write"; + /** @enum {string} */ + emails: "read" | "write"; + /** @enum {string} */ + environments: "read" | "write"; + /** @enum {string} */ + issues: "read" | "write"; + /** @enum {string} */ + keys: "read" | "write"; + /** @enum {string} */ + members: "read" | "write"; + /** @enum {string} */ + metadata: "read" | "write"; + /** @enum {string} */ + organization_administration: "read" | "write"; + /** @enum {string} */ + organization_hooks: "read" | "write"; + /** @enum {string} */ + organization_packages: "read" | "write"; + /** @enum {string} */ + organization_plan: "read" | "write"; + /** @enum {string} */ + organization_projects: "read" | "write" | "admin"; + /** @enum {string} */ + organization_secrets: "read" | "write"; + /** @enum {string} */ + organization_self_hosted_runners: "read" | "write"; + /** @enum {string} */ + organization_user_blocking: "read" | "write"; + /** @enum {string} */ + packages: "read" | "write"; + /** @enum {string} */ + pages: "read" | "write"; + /** @enum {string} */ + pull_requests: "read" | "write"; + /** @enum {string} */ + repository_hooks: "read" | "write"; + /** @enum {string} */ + repository_projects: "read" | "write" | "admin"; + /** @enum {string} */ + secret_scanning_alerts: "read" | "write"; + /** @enum {string} */ + secrets: "read" | "write"; + /** @enum {string} */ + security_events: "read" | "write"; + /** @enum {string} */ + security_scanning_alert: "read" | "write"; + /** @enum {string} */ + single_file: "read" | "write"; + /** @enum {string} */ + statuses: "read" | "write"; + /** @enum {string} */ + team_discussions: "read" | "write"; + /** @enum {string} */ + vulnerability_alerts: "read" | "write"; + /** @enum {string} */ + workflows: "read" | "write"; + }; + /** @description The slug name of the GitHub app */ + slug?: string; + /** Format: date-time */ + updated_at: string | null; + } | null; + pull_request?: { + /** Format: uri */ + diff_url: string; + /** Format: uri */ + html_url: string; + /** Format: date-time */ + merged_at: string | null; + /** Format: uri */ + patch_url: string; + /** Format: uri */ + url: string; + }; /** Reactions */ reactions: { "+1": number; @@ -44021,11 +45027,29 @@ export interface components { /** Format: uri */ url: string; }; + /** Format: uri */ + repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; + /** + * @description State of the issue; either 'open' or 'closed' + * @enum {string} + */ + state?: "open" | "closed"; + state_reason?: string | null; + /** Format: uri */ + timeline_url?: string; + /** @description Title of the issue */ + title: string; /** Format: date-time */ updated_at: string; /** * Format: uri - * @description URL for the issue comment + * @description URL for the issue */ url: string; /** User */ @@ -44062,12 +45086,135 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null; + } & { + active_lock_reason?: string | null; + /** User */ + assignee: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; user_view_type?: string; } | null; + assignees?: Record[]; + author_association?: string; + body?: string | null; + closed_at?: string | null; + comments?: number; + comments_url?: string; + created_at?: string; + events_url?: string; + html_url?: string; + id?: number; + labels: { + /** @description 6-character hex code, without the leading #, identifying the color */ + color: string; + default: boolean; + description: string | null; + id: number; + /** @description The name of the label. */ + name: string; + node_id: string; + /** + * Format: uri + * @description URL for the label + */ + url: string; + }[]; + labels_url?: string; + locked: boolean; + milestone?: Record; + node_id?: string; + number?: number; + performed_via_github_app?: Record; + reactions?: { + "+1": number; + "-1": number; + confused: number; + eyes: number; + heart: number; + hooray: number; + laugh: number; + rocket: number; + total_count: number; + url: string; + }; + repository_url?: string; + /** + * @description State of the issue; either 'open' or 'closed' + * @enum {string} + */ + state: "open" | "closed"; + timeline_url?: string; + title?: string; + updated_at?: string; + url?: string; + user?: { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string; + html_url: string; + /** Format: int64 */ + id: number; + login: string; + node_id: string; + organizations_url: string; + received_events_url: string; + repos_url: string; + site_admin: boolean; + starred_url: string; + subscriptions_url: string; + type: string; + url: string; + }; }; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; + }; + /** issue_comment deleted event */ + "webhook-issue-comment-deleted": { + /** @enum {string} */ + action: "deleted"; + comment: components["schemas"]["webhooks_issue_comment"]; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. */ @@ -44272,7 +45419,7 @@ export interface components { created_at: string | null; description: string | null; /** @description The list of events for the GitHub app */ - events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "pull_request_review_thread")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; /** Format: uri */ external_url: string | null; /** Format: uri */ @@ -44357,7 +45504,7 @@ export interface components { /** @enum {string} */ organization_plan: "read" | "write"; /** @enum {string} */ - organization_projects: "read" | "write" | "admin"; + organization_projects: "read" | "write"; /** @enum {string} */ organization_secrets: "read" | "write"; /** @enum {string} */ @@ -44373,7 +45520,7 @@ export interface components { /** @enum {string} */ repository_hooks: "read" | "write"; /** @enum {string} */ - repository_projects: "read" | "write" | "admin"; + repository_projects: "read" | "write"; /** @enum {string} */ secret_scanning_alerts: "read" | "write"; /** @enum {string} */ @@ -44426,6 +45573,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -44595,16 +45748,18 @@ export interface components { subscriptions_url: string; type: string; url: string; + user_view_type: string; }; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; }; - /** issue_comment deleted event */ - "webhook-issue-comment-deleted": { + /** issue_comment edited event */ + "webhook-issue-comment-edited": { /** @enum {string} */ - action: "deleted"; + action: "edited"; + changes: components["schemas"]["webhooks_changes"]; comment: components["schemas"]["webhooks_issue_comment"]; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; @@ -44810,7 +45965,7 @@ export interface components { created_at: string | null; description: string | null; /** @description The list of events for the GitHub app */ - events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "pull_request_review_thread")[]; /** Format: uri */ external_url: string | null; /** Format: uri */ @@ -44895,7 +46050,7 @@ export interface components { /** @enum {string} */ organization_plan: "read" | "write"; /** @enum {string} */ - organization_projects: "read" | "write"; + organization_projects: "read" | "write" | "admin"; /** @enum {string} */ organization_secrets: "read" | "write"; /** @enum {string} */ @@ -44964,6 +46119,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -45133,22 +46294,37 @@ export interface components { subscriptions_url: string; type: string; url: string; - user_view_type: string; }; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; }; - /** issue_comment edited event */ - "webhook-issue-comment-edited": { - /** @enum {string} */ - action: "edited"; - changes: components["schemas"]["webhooks_changes"]; - comment: components["schemas"]["webhooks_issue_comment"]; + /** issues assigned event */ + "webhook-issues-assigned": { + /** + * @description The action that was performed. + * @enum {string} + */ + action: "assigned"; + assignee?: components["schemas"]["webhooks_user"]; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; - /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. */ + issue: components["schemas"]["webhooks_issue"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; + }; + /** issues closed event */ + "webhook-issues-closed": { + /** + * @description The action that was performed. + * @enum {string} + */ + action: "closed"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ issue: { /** @enum {string|null} */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; @@ -45350,7 +46526,7 @@ export interface components { created_at: string | null; description: string | null; /** @description The list of events for the GitHub app */ - events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "pull_request_review_thread")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "security_and_analysis" | "reminder" | "pull_request_review_thread")[]; /** Format: uri */ external_url: string | null; /** Format: uri */ @@ -45504,6 +46680,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -45562,71 +46744,20 @@ export interface components { } | null; } & { active_lock_reason?: string | null; - /** User */ - assignee: { - /** Format: uri */ - avatar_url?: string; - deleted?: boolean; - email?: string | null; - /** Format: uri-template */ - events_url?: string; - /** Format: uri */ - followers_url?: string; - /** Format: uri-template */ - following_url?: string; - /** Format: uri-template */ - gists_url?: string; - gravatar_id?: string; - /** Format: uri */ - html_url?: string; - id: number; - login: string; - name?: string; - node_id?: string; - /** Format: uri */ - organizations_url?: string; - /** Format: uri */ - received_events_url?: string; - /** Format: uri */ - repos_url?: string; - site_admin?: boolean; - /** Format: uri-template */ - starred_url?: string; - /** Format: uri */ - subscriptions_url?: string; - /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ - url?: string; - user_view_type?: string; - } | null; + assignee?: Record; assignees?: Record[]; author_association?: string; body?: string | null; - closed_at?: string | null; + closed_at: string | null; comments?: number; comments_url?: string; created_at?: string; events_url?: string; html_url?: string; id?: number; - labels: { - /** @description 6-character hex code, without the leading #, identifying the color */ - color: string; - default: boolean; - description: string | null; - id: number; - /** @description The name of the label. */ - name: string; - node_id: string; - /** - * Format: uri - * @description URL for the label - */ - url: string; - }[]; + labels?: Record[]; labels_url?: string; - locked: boolean; + locked?: boolean; milestone?: Record; node_id?: string; number?: number; @@ -45644,11 +46775,8 @@ export interface components { url: string; }; repository_url?: string; - /** - * @description State of the issue; either 'open' or 'closed' - * @enum {string} - */ - state: "open" | "closed"; + /** @enum {string} */ + state: "closed" | "open"; timeline_url?: string; title?: string; updated_at?: string; @@ -45673,37 +46801,23 @@ export interface components { subscriptions_url: string; type: string; url: string; + user_view_type: string; }; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; }; - /** issues assigned event */ - "webhook-issues-assigned": { - /** - * @description The action that was performed. - * @enum {string} - */ - action: "assigned"; - assignee?: components["schemas"]["webhooks_user"]; + /** issues deleted event */ + "webhook-issues-deleted": { + /** @enum {string} */ + action: "deleted"; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; - issue: components["schemas"]["webhooks_issue"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user"]; - }; - /** issues closed event */ - "webhook-issues-closed": { /** - * @description The action that was performed. - * @enum {string} + * Issue + * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ - action: "closed"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ issue: { /** @enum {string|null} */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; @@ -45740,7 +46854,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; user_view_type?: string; @@ -45777,10 +46891,9 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; - user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -45865,7 +46978,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; user_view_type?: string; @@ -45905,7 +47018,7 @@ export interface components { created_at: string | null; description: string | null; /** @description The list of events for the GitHub app */ - events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "security_and_analysis" | "reminder" | "pull_request_review_thread")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder")[]; /** Format: uri */ external_url: string | null; /** Format: uri */ @@ -45990,7 +47103,7 @@ export interface components { /** @enum {string} */ organization_plan: "read" | "write"; /** @enum {string} */ - organization_projects: "read" | "write" | "admin"; + organization_projects: "read" | "write"; /** @enum {string} */ organization_secrets: "read" | "write"; /** @enum {string} */ @@ -46059,6 +47172,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -46110,81 +47229,20 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; user_view_type?: string; } | null; - } & { - active_lock_reason?: string | null; - assignee?: Record; - assignees?: Record[]; - author_association?: string; - body?: string | null; - closed_at: string | null; - comments?: number; - comments_url?: string; - created_at?: string; - events_url?: string; - html_url?: string; - id?: number; - labels?: Record[]; - labels_url?: string; - locked?: boolean; - milestone?: Record; - node_id?: string; - number?: number; - performed_via_github_app?: Record; - reactions?: { - "+1": number; - "-1": number; - confused: number; - eyes: number; - heart: number; - hooray: number; - laugh: number; - rocket: number; - total_count: number; - url: string; - }; - repository_url?: string; - /** @enum {string} */ - state: "closed" | "open"; - timeline_url?: string; - title?: string; - updated_at?: string; - url?: string; - user?: { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - /** Format: int64 */ - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - user_view_type: string; - }; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; }; - /** issues deleted event */ - "webhook-issues-deleted": { + /** issues demilestoned event */ + "webhook-issues-demilestoned": { /** @enum {string} */ - action: "deleted"; + action: "demilestoned"; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** @@ -46227,10 +47285,9 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -46264,7 +47321,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; } | null)[]; @@ -46290,7 +47347,7 @@ export interface components { html_url: string; /** Format: int64 */ id: number; - labels?: { + labels?: ({ /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; @@ -46304,7 +47361,7 @@ export interface components { * @description URL for the label */ url: string; - }[]; + } | null)[]; /** Format: uri-template */ labels_url: string; locked?: boolean; @@ -46351,7 +47408,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; user_view_type?: string; @@ -46391,7 +47448,7 @@ export interface components { created_at: string | null; description: string | null; /** @description The list of events for the GitHub app */ - events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; /** Format: uri */ external_url: string | null; /** Format: uri */ @@ -46476,7 +47533,7 @@ export interface components { /** @enum {string} */ organization_plan: "read" | "write"; /** @enum {string} */ - organization_projects: "read" | "write"; + organization_projects: "read" | "write" | "admin"; /** @enum {string} */ organization_secrets: "read" | "write"; /** @enum {string} */ @@ -46545,6 +47602,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -46596,20 +47659,32 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; user_view_type?: string; } | null; }; + milestone?: components["schemas"]["webhooks_milestone"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; }; - /** issues demilestoned event */ - "webhook-issues-demilestoned": { + /** issues edited event */ + "webhook-issues-edited": { /** @enum {string} */ - action: "demilestoned"; + action: "edited"; + /** @description The changes to the issue. */ + changes: { + body: { + /** @description The previous version of the body. */ + from: string; + }; + title: { + /** @description The previous version of the title. */ + from: string; + }; + }; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** @@ -46655,6 +47730,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -46714,7 +47790,7 @@ export interface components { html_url: string; /** Format: int64 */ id: number; - labels?: ({ + labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; @@ -46728,7 +47804,7 @@ export interface components { * @description URL for the label */ url: string; - } | null)[]; + }[]; /** Format: uri-template */ labels_url: string; locked?: boolean; @@ -46815,7 +47891,7 @@ export interface components { created_at: string | null; description: string | null; /** @description The list of events for the GitHub app */ - events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "security_and_analysis" | "pull_request_review_thread" | "reminder")[]; /** Format: uri */ external_url: string | null; /** Format: uri */ @@ -46969,6 +48045,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -47026,26 +48108,15 @@ export interface components { user_view_type?: string; } | null; }; - milestone?: components["schemas"]["webhooks_milestone"]; + label?: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; }; - /** issues edited event */ - "webhook-issues-edited": { + /** issues labeled event */ + "webhook-issues-labeled": { /** @enum {string} */ - action: "edited"; - /** @description The changes to the issue. */ - changes: { - body: { - /** @description The previous version of the body. */ - from: string; - }; - title: { - /** @description The previous version of the title. */ - from: string; - }; - }; + action: "labeled"; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** @@ -47252,7 +48323,7 @@ export interface components { created_at: string | null; description: string | null; /** @description The list of events for the GitHub app */ - events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "security_and_analysis" | "pull_request_review_thread" | "reminder")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "reminder")[]; /** Format: uri */ external_url: string | null; /** Format: uri */ @@ -47406,6 +48477,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -47468,10 +48545,10 @@ export interface components { repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; }; - /** issues labeled event */ - "webhook-issues-labeled": { + /** issues locked event */ + "webhook-issues-locked": { /** @enum {string} */ - action: "labeled"; + action: "locked"; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** @@ -47514,7 +48591,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; user_view_type?: string; @@ -47551,9 +48628,10 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -47577,7 +48655,7 @@ export interface components { html_url: string; /** Format: int64 */ id: number; - labels?: { + labels?: ({ /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; @@ -47591,10 +48669,11 @@ export interface components { * @description URL for the label */ url: string; - }[]; + } | null)[]; /** Format: uri-template */ labels_url: string; - locked?: boolean; + /** @enum {boolean} */ + locked: true; /** * Milestone * @description A collection of related issues and pull requests. @@ -47638,7 +48717,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; user_view_type?: string; @@ -47678,7 +48757,7 @@ export interface components { created_at: string | null; description: string | null; /** @description The list of events for the GitHub app */ - events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "reminder")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "security_and_analysis")[]; /** Format: uri */ external_url: string | null; /** Format: uri */ @@ -47763,7 +48842,7 @@ export interface components { /** @enum {string} */ organization_plan: "read" | "write"; /** @enum {string} */ - organization_projects: "read" | "write" | "admin"; + organization_projects: "read" | "write"; /** @enum {string} */ organization_secrets: "read" | "write"; /** @enum {string} */ @@ -47832,6 +48911,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -47883,21 +48968,20 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; user_view_type?: string; } | null; }; - label?: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; }; - /** issues locked event */ - "webhook-issues-locked": { + /** issues milestoned event */ + "webhook-issues-milestoned": { /** @enum {string} */ - action: "locked"; + action: "milestoned"; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** @@ -47943,7 +49027,6 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; - user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -47980,7 +49063,6 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; - user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -48021,8 +49103,7 @@ export interface components { } | null)[]; /** Format: uri-template */ labels_url: string; - /** @enum {boolean} */ - locked: true; + locked?: boolean; /** * Milestone * @description A collection of related issues and pull requests. @@ -48066,7 +49147,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; user_view_type?: string; @@ -48106,7 +49187,7 @@ export interface components { created_at: string | null; description: string | null; /** @description The list of events for the GitHub app */ - events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "security_and_analysis")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder")[]; /** Format: uri */ external_url: string | null; /** Format: uri */ @@ -48191,7 +49272,7 @@ export interface components { /** @enum {string} */ organization_plan: "read" | "write"; /** @enum {string} */ - organization_projects: "read" | "write"; + organization_projects: "read" | "write" | "admin"; /** @enum {string} */ organization_secrets: "read" | "write"; /** @enum {string} */ @@ -48260,430 +49341,12 @@ export interface components { }; /** Format: uri */ repository_url: string; - /** - * @description State of the issue; either 'open' or 'closed' - * @enum {string} - */ - state?: "open" | "closed"; - state_reason?: string | null; - /** Format: uri */ - timeline_url?: string; - /** @description Title of the issue */ - title: string; - /** Format: date-time */ - updated_at: string; - /** - * Format: uri - * @description URL for the issue - */ - url: string; - /** User */ - user: { - /** Format: uri */ - avatar_url?: string; - deleted?: boolean; - email?: string | null; - /** Format: uri-template */ - events_url?: string; - /** Format: uri */ - followers_url?: string; - /** Format: uri-template */ - following_url?: string; - /** Format: uri-template */ - gists_url?: string; - gravatar_id?: string; - /** Format: uri */ - html_url?: string; - /** Format: int64 */ - id: number; - login: string; - name?: string; - node_id?: string; - /** Format: uri */ - organizations_url?: string; - /** Format: uri */ - received_events_url?: string; - /** Format: uri */ - repos_url?: string; - site_admin?: boolean; - /** Format: uri-template */ - starred_url?: string; - /** Format: uri */ - subscriptions_url?: string; - /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; - /** Format: uri */ - url?: string; - user_view_type?: string; - } | null; - }; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user"]; - }; - /** issues milestoned event */ - "webhook-issues-milestoned": { - /** @enum {string} */ - action: "milestoned"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - /** - * Issue - * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. - */ - issue: { - /** @enum {string|null} */ - active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ - assignee?: { - /** Format: uri */ - avatar_url?: string; - deleted?: boolean; - email?: string | null; - /** Format: uri-template */ - events_url?: string; - /** Format: uri */ - followers_url?: string; - /** Format: uri-template */ - following_url?: string; - /** Format: uri-template */ - gists_url?: string; - gravatar_id?: string; - /** Format: uri */ - html_url?: string; - id: number; - login: string; - name?: string; - node_id?: string; - /** Format: uri */ - organizations_url?: string; - /** Format: uri */ - received_events_url?: string; - /** Format: uri */ - repos_url?: string; - site_admin?: boolean; - /** Format: uri-template */ - starred_url?: string; - /** Format: uri */ - subscriptions_url?: string; - /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; - /** Format: uri */ - url?: string; - } | null; - assignees: ({ - /** Format: uri */ - avatar_url?: string; - deleted?: boolean; - email?: string | null; - /** Format: uri-template */ - events_url?: string; - /** Format: uri */ - followers_url?: string; - /** Format: uri-template */ - following_url?: string; - /** Format: uri-template */ - gists_url?: string; - gravatar_id?: string; - /** Format: uri */ - html_url?: string; - id: number; - login: string; - name?: string; - node_id?: string; - /** Format: uri */ - organizations_url?: string; - /** Format: uri */ - received_events_url?: string; - /** Format: uri */ - repos_url?: string; - site_admin?: boolean; - /** Format: uri-template */ - starred_url?: string; - /** Format: uri */ - subscriptions_url?: string; - /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; - /** Format: uri */ - url?: string; - } | null)[]; - /** - * AuthorAssociation - * @description How the author is associated with the repository. - * @enum {string} - */ - author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ - body: string | null; - /** Format: date-time */ - closed_at: string | null; - comments: number; - /** Format: uri */ - comments_url: string; - /** Format: date-time */ - created_at: string; - draft?: boolean; - /** Format: uri */ - events_url: string; - /** Format: uri */ - html_url: string; - /** Format: int64 */ - id: number; - labels?: ({ - /** @description 6-character hex code, without the leading #, identifying the color */ - color: string; - default: boolean; - description: string | null; - id: number; - /** @description The name of the label. */ - name: string; - node_id: string; - /** - * Format: uri - * @description URL for the label - */ - url: string; - } | null)[]; - /** Format: uri-template */ - labels_url: string; - locked?: boolean; - /** - * Milestone - * @description A collection of related issues and pull requests. - */ - milestone: { - /** Format: date-time */ - closed_at: string | null; - closed_issues: number; - /** Format: date-time */ - created_at: string; - /** User */ - creator: { - /** Format: uri */ - avatar_url?: string; - deleted?: boolean; - email?: string | null; - /** Format: uri-template */ - events_url?: string; - /** Format: uri */ - followers_url?: string; - /** Format: uri-template */ - following_url?: string; - /** Format: uri-template */ - gists_url?: string; - gravatar_id?: string; - /** Format: uri */ - html_url?: string; - id: number; - login: string; - name?: string; - node_id?: string; - /** Format: uri */ - organizations_url?: string; - /** Format: uri */ - received_events_url?: string; - /** Format: uri */ - repos_url?: string; - site_admin?: boolean; - /** Format: uri-template */ - starred_url?: string; - /** Format: uri */ - subscriptions_url?: string; - /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ - url?: string; - user_view_type?: string; - } | null; - description: string | null; - /** Format: date-time */ - due_on: string | null; - /** Format: uri */ - html_url: string; - id: number; - /** Format: uri */ - labels_url: string; - node_id: string; - /** @description The number of the milestone. */ - number: number; - open_issues: number; - /** - * @description The state of the milestone. - * @enum {string} - */ - state: "open" | "closed"; - /** @description The title of the milestone. */ - title: string; - /** Format: date-time */ - updated_at: string; - /** Format: uri */ - url: string; - } | null; - node_id: string; - number: number; - /** - * App - * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. - */ - performed_via_github_app?: { - /** Format: date-time */ - created_at: string | null; - description: string | null; - /** @description The list of events for the GitHub app */ - events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder")[]; - /** Format: uri */ - external_url: string | null; - /** Format: uri */ - html_url: string; - /** @description Unique identifier of the GitHub app */ - id: number | null; - /** @description The name of the GitHub app */ - name: string; - node_id: string; - /** User */ - owner: { - /** Format: uri */ - avatar_url?: string; - deleted?: boolean; - email?: string | null; - /** Format: uri-template */ - events_url?: string; - /** Format: uri */ - followers_url?: string; - /** Format: uri-template */ - following_url?: string; - /** Format: uri-template */ - gists_url?: string; - gravatar_id?: string; - /** Format: uri */ - html_url?: string; - id: number; - login: string; - name?: string; - node_id?: string; - /** Format: uri */ - organizations_url?: string; - /** Format: uri */ - received_events_url?: string; - /** Format: uri */ - repos_url?: string; - site_admin?: boolean; - /** Format: uri-template */ - starred_url?: string; - /** Format: uri */ - subscriptions_url?: string; - /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; - /** Format: uri */ - url?: string; - user_view_type?: string; - } | null; - /** @description The set of permissions for the GitHub app */ - permissions?: { - /** @enum {string} */ - actions: "read" | "write"; - /** @enum {string} */ - administration: "read" | "write"; - /** @enum {string} */ - checks: "read" | "write"; - /** @enum {string} */ - content_references: "read" | "write"; - /** @enum {string} */ - contents: "read" | "write"; - /** @enum {string} */ - deployments: "read" | "write"; - /** @enum {string} */ - discussions: "read" | "write"; - /** @enum {string} */ - emails: "read" | "write"; - /** @enum {string} */ - environments: "read" | "write"; - /** @enum {string} */ - issues: "read" | "write"; - /** @enum {string} */ - keys: "read" | "write"; - /** @enum {string} */ - members: "read" | "write"; - /** @enum {string} */ - metadata: "read" | "write"; - /** @enum {string} */ - organization_administration: "read" | "write"; - /** @enum {string} */ - organization_hooks: "read" | "write"; - /** @enum {string} */ - organization_packages: "read" | "write"; - /** @enum {string} */ - organization_plan: "read" | "write"; - /** @enum {string} */ - organization_projects: "read" | "write" | "admin"; - /** @enum {string} */ - organization_secrets: "read" | "write"; - /** @enum {string} */ - organization_self_hosted_runners: "read" | "write"; - /** @enum {string} */ - organization_user_blocking: "read" | "write"; - /** @enum {string} */ - packages: "read" | "write"; - /** @enum {string} */ - pages: "read" | "write"; - /** @enum {string} */ - pull_requests: "read" | "write"; - /** @enum {string} */ - repository_hooks: "read" | "write"; - /** @enum {string} */ - repository_projects: "read" | "write"; - /** @enum {string} */ - secret_scanning_alerts: "read" | "write"; - /** @enum {string} */ - secrets: "read" | "write"; - /** @enum {string} */ - security_events: "read" | "write"; - /** @enum {string} */ - security_scanning_alert: "read" | "write"; - /** @enum {string} */ - single_file: "read" | "write"; - /** @enum {string} */ - statuses: "read" | "write"; - /** @enum {string} */ - team_discussions: "read" | "write"; - /** @enum {string} */ - vulnerability_alerts: "read" | "write"; - /** @enum {string} */ - workflows: "read" | "write"; - }; - /** @description The slug name of the GitHub app */ - slug?: string; - /** Format: date-time */ - updated_at: string | null; - } | null; - pull_request?: { - /** Format: uri */ - diff_url: string; - /** Format: uri */ - html_url: string; - /** Format: date-time */ - merged_at: string | null; - /** Format: uri */ - patch_url: string; - /** Format: uri */ - url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; }; - /** Reactions */ - reactions: { - "+1": number; - "-1": number; - confused: number; - eyes: number; - heart: number; - hooray: number; - laugh: number; - rocket: number; - total_count: number; - /** Format: uri */ - url: string; - }; - /** Format: uri */ - repository_url: string; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -49110,6 +49773,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -49776,6 +50445,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -50211,6 +50886,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -50636,6 +51317,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -51344,6 +52031,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -82571,6 +83264,45 @@ export interface components { repository: components["schemas"]["repository-webhooks"]; sender?: components["schemas"]["simple-user"]; }; + /** secret_scanning_scan completed event */ + "webhook-secret-scanning-scan-completed": { + /** @enum {string} */ + action: "completed"; + /** + * @description What type of scan was completed + * @enum {string} + */ + type: "backfill" | "custom-pattern-backfill" | "pattern-version-backfill"; + /** + * @description What type of content was scanned + * @enum {string} + */ + source: "git" | "issues" | "pull-requests" | "discussions" | "wiki"; + /** + * Format: date-time + * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + started_at: string; + /** + * Format: date-time + * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + completed_at: string; + /** @description List of patterns that were updated. This will be empty for normal backfill scans or custom pattern updates */ + secret_types?: string[] | null; + /** @description If the scan was triggered by a custom pattern update, this will be the name of the pattern that was updated */ + custom_pattern_name?: string | null; + /** + * @description If the scan was triggered by a custom pattern update, this will be the scope of the pattern that was updated + * @enum {string|null} + */ + custom_pattern_scope?: "repository" | "organization" | "enterprise" | null; + repository?: components["schemas"]["repository-webhooks"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + sender?: components["schemas"]["simple-user"]; + }; /** security_advisory published event */ "webhook-security-advisory-published": { /** @enum {string} */ @@ -82850,6 +83582,7 @@ export interface components { reason: "expired_key" | "not_signing_key" | "gpgverify_error" | "gpgverify_unavailable" | "unsigned" | "unknown_signature_type" | "no_user" | "unverified_email" | "bad_email" | "unknown_key" | "malformed_signature" | "invalid" | "valid" | "bad_cert" | "ocsp_pending"; signature: string | null; verified: boolean; + verified_at?: string | null; }; }; /** User */ @@ -86045,8 +86778,8 @@ export interface components { "application/json": components["schemas"]["basic-error"]; }; }; - /** @description Internal Error */ - internal_error: { + /** @description Conflict */ + conflict: { headers: { [name: string]: unknown; }; @@ -86054,14 +86787,12 @@ export interface components { "application/json": components["schemas"]["basic-error"]; }; }; - /** @description Copilot Usage Merics API setting is disabled at the organization or enterprise level. */ - usage_metrics_api_disabled: { + /** @description A header with no content is returned. */ + no_content: { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["basic-error"]; - }; + content?: never; }; /** @description Service unavailable */ service_unavailable: { @@ -86102,8 +86833,17 @@ export interface components { "application/json": components["schemas"]["basic-error"]; }; }; - /** @description Conflict */ - conflict: { + /** @description Billing usage report response for an organization */ + billing_usage_report_org: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["billing-usage-report"]; + }; + }; + /** @description Internal Error */ + internal_error: { headers: { [name: string]: unknown; }; @@ -86148,12 +86888,14 @@ export interface components { }; }; }; - /** @description A header with no content is returned. */ - no_content: { + /** @description Copilot Usage Merics API setting is disabled at the organization or enterprise level. */ + usage_metrics_api_disabled: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["basic-error"]; + }; }; /** @description The value of `per_page` multiplied by `page` cannot be greater than 10000. */ package_es_list_error: { @@ -86198,6 +86940,24 @@ export interface components { "application/json": components["schemas"]["basic-error"]; }; }; + /** @description Bad Request */ + code_scanning_bad_request: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + /** @description Response if the repository is archived, if GitHub Advanced Security is not enabled for this repository or if rate limit is exceeded */ + code_scanning_autofix_create_forbidden: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; /** @description Found */ found: { headers: { @@ -86271,6 +87031,8 @@ export interface components { "classroom-id": number; /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: string; + /** @description The unique identifier of the code security configuration. */ + "configuration-id": number; /** @description A comma-separated list of states. If specified, only alerts with these states will be returned. * * Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` */ @@ -86301,9 +87063,7 @@ export interface components { "pagination-last": number; /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ "secret-scanning-alert-state": "open" | "resolved"; - /** @description A comma-separated list of secret types to return. By default all secret types are returned. - * See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" - * for a complete list of secret types. */ + /** @description A comma-separated list of secret types to return. All default secret patterns are returned. To return experimental patterns, pass the token name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. */ "secret-scanning-alert-secret-type": string; /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ "secret-scanning-alert-resolution": string; @@ -86315,10 +87075,6 @@ export interface components { "secret-scanning-alert-publicly-leaked": boolean; /** @description A boolean value representing whether or not to filter alerts by the multi-repo tag being present. */ "secret-scanning-alert-multi-repo": boolean; - /** @description The slug of the enterprise team name. */ - "enterprise-team-slug": string; - /** @description The slug of the team name. */ - "team-slug": string; /** @description The unique identifier of the gist. */ "gist-id": string; /** @description The unique identifier of the comment. */ @@ -86347,6 +87103,14 @@ export interface components { "since-org": number; /** @description The organization name. The name is not case sensitive. */ org: string; + /** @description If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2024`. Default value is the current year. */ + "billing-usage-report-year": number; + /** @description If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. */ + "billing-usage-report-month": number; + /** @description If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. */ + "billing-usage-report-day": number; + /** @description If specified, only return results for a single hour. The value of `hour` is an integer between `0` and `23`. */ + "billing-usage-report-hour": number; /** @description The unique identifier of the repository. */ "repository-id": number; /** @description Only return runner groups that are allowed to be used by this repository. */ @@ -86369,26 +87133,30 @@ export interface components { "tool-name": components["schemas"]["code-scanning-analysis-tool-name"]; /** @description The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both. */ "tool-guid": components["schemas"]["code-scanning-analysis-tool-guid"]; - /** @description The unique identifier of the code security configuration. */ - "configuration-id": number; /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ "hook-id": number; /** @description The type of the actor */ - "api-insights-actor-type": "installations" | "classic_pats" | "fine_grained_pats" | "oauth_apps" | "github_apps_user_to_server"; + "api-insights-actor-type": "installation" | "classic_pat" | "fine_grained_pat" | "oauth_app" | "github_app_user_to_server"; /** @description The ID of the actor */ "api-insights-actor-id": number; - /** @description The minimum timestamp to query for stats */ + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ "api-insights-min-timestamp": string; - /** @description The maximum timestamp to query for stats */ + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ "api-insights-max-timestamp": string; /** @description The property to sort the results by. */ "api-insights-route-stats-sort": ("last_rate_limited_timestamp" | "last_request_timestamp" | "rate_limited_request_count" | "http_method" | "api_route" | "total_request_count")[]; + /** @description Providing a substring will filter results where the API route contains the substring. This is a case-insensitive search. */ + "api-insights-api-route-substring": string; /** @description The property to sort the results by. */ "api-insights-sort": ("last_rate_limited_timestamp" | "last_request_timestamp" | "rate_limited_request_count" | "subject_name" | "total_request_count")[]; + /** @description Providing a substring will filter results where the subject name contains the substring. This is a case-insensitive search. */ + "api-insights-subject-name-substring": string; /** @description The ID of the user to query for stats */ "api-insights-user-id": string; /** @description The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) */ "api-insights-timestamp-increment": string; + /** @description Providing a substring will filter results where the actor name contains the substring. This is a case-insensitive search. */ + "api-insights-actor-name-substring": string; /** @description The unique identifier of the invitation. */ "invitation-id": number; /** @description The name of the codespace. */ @@ -86397,6 +87165,8 @@ export interface components { "migration-id": number; /** @description repo_name parameter */ "repo-name": string; + /** @description The slug of the team name. */ + "team-slug": string; /** @description The unique identifier of the role. */ "role-id": number; /** @description The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -86433,8 +87203,8 @@ export interface components { "ruleset-targets": string; /** @description The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. */ "ref-in-query": string; - /** @description The name of the repository to filter on. When specified, only rule evaluations from this repository will be returned. */ - "repository-name-in-query": number; + /** @description The name of the repository to filter on. */ + "repository-name-in-query": string; /** @description The time period to filter by. * * For example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for insights that occurred in the past 7 days (168 hours). */ @@ -87519,13 +88289,15 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; - "copilot/list-copilot-seats-for-enterprise": { + "code-security/get-configurations-for-enterprise": { parameters: { query?: { - /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - page?: components["parameters"]["page"]; /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: number; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + before?: components["parameters"]["pagination-before"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + after?: components["parameters"]["pagination-after"]; }; header?: never; path: { @@ -87539,39 +88311,164 @@ export interface operations { /** @description Response */ 200: { headers: { - Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": { - /** @description The total number of Copilot seats the enterprise is being billed for. Users with access through multiple organizations or enterprise teams are only counted once. */ - total_seats: number; - seats: components["schemas"]["copilot-seat-details"][]; + "application/json": components["schemas"]["code-security-configuration"][]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "code-security/create-configuration-for-enterprise": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + enterprise: components["parameters"]["enterprise"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description The name of the code security configuration. Must be unique within the enterprise. */ + name: string; + /** @description A description of the code security configuration */ + description: string; + /** + * @description The enablement status of GitHub Advanced Security + * @default disabled + * @enum {string} + */ + advanced_security?: "enabled" | "disabled"; + /** + * @description The enablement status of Dependency Graph + * @default enabled + * @enum {string} + */ + dependency_graph?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Automatic dependency submission + * @default disabled + * @enum {string} + */ + dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for Automatic dependency submission */ + dependency_graph_autosubmit_action_options?: { + /** + * @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. + * @default false + */ + labeled_runners: boolean; }; + /** + * @description The enablement status of Dependabot alerts + * @default disabled + * @enum {string} + */ + dependabot_alerts?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot security updates + * @default disabled + * @enum {string} + */ + dependabot_security_updates?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of code scanning default setup + * @default disabled + * @enum {string} + */ + code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; + code_scanning_default_setup_options?: components["schemas"]["code-scanning-default-setup-options"]; + /** + * @description The enablement status of secret scanning + * @default disabled + * @enum {string} + */ + secret_scanning?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning push protection + * @default disabled + * @enum {string} + */ + secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning validity checks + * @default disabled + * @enum {string} + */ + secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning non provider patterns + * @default disabled + * @enum {string} + */ + secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of private vulnerability reporting + * @default disabled + * @enum {string} + */ + private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; + /** + * @description The enforcement status for a security configuration + * @default enforced + * @enum {string} + */ + enforcement?: "enforced" | "unenforced"; }; }; - 401: components["responses"]["requires_authentication"]; + }; + responses: { + /** @description Successfully created code security configuration */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["code-security-configuration"]; + }; + }; + 400: components["responses"]["bad_request"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; }; }; - "copilot/copilot-metrics-for-enterprise": { + "code-security/get-default-configurations-for-enterprise": { parameters: { - query?: { - /** @description Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago. */ - since?: string; - /** @description Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed. */ - until?: string; - /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - page?: components["parameters"]["page"]; - /** @description The number of days of metrics to display per page (max 28). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - per_page?: number; + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + enterprise: components["parameters"]["enterprise"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["code-security-default-configurations"]; + }; }; + }; + }; + "code-security/get-single-configuration-for-enterprise": { + parameters: { + query?: never; header?: never; path: { /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description The unique identifier of the code security configuration. */ + configuration_id: components["parameters"]["configuration-id"]; }; cookie?: never; }; @@ -87583,31 +88480,233 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["copilot-usage-metrics-day"][]; + "application/json": components["schemas"]["code-security-configuration"]; }; }; + 304: components["responses"]["not_modified"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - 422: components["responses"]["usage_metrics_api_disabled"]; - 500: components["responses"]["internal_error"]; }; }; - "copilot/usage-metrics-for-enterprise": { + "code-security/delete-configuration-for-enterprise": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The unique identifier of the code security configuration. */ + configuration_id: components["parameters"]["configuration-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 204: components["responses"]["no_content"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + }; + }; + "code-security/update-enterprise-configuration": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The unique identifier of the code security configuration. */ + configuration_id: components["parameters"]["configuration-id"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description The name of the code security configuration. Must be unique across the enterprise. */ + name: string; + /** @description A description of the code security configuration */ + description: string; + /** + * @description The enablement status of GitHub Advanced Security. Must be set to enabled if you want to enable any GHAS settings. + * @enum {string} + */ + advanced_security: "enabled" | "disabled"; + /** + * @description The enablement status of Dependency Graph + * @enum {string} + */ + dependency_graph: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Automatic dependency submission + * @enum {string} + */ + dependency_graph_autosubmit_action: "enabled" | "disabled" | "not_set"; + /** @description Feature options for Automatic dependency submission */ + dependency_graph_autosubmit_action_options: { + /** @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. */ + labeled_runners: boolean; + }; + /** + * @description The enablement status of Dependabot alerts + * @enum {string} + */ + dependabot_alerts: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot security updates + * @enum {string} + */ + dependabot_security_updates: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of code scanning default setup + * @enum {string} + */ + code_scanning_default_setup: "enabled" | "disabled" | "not_set"; + code_scanning_default_setup_options: components["schemas"]["code-scanning-default-setup-options"]; + /** + * @description The enablement status of secret scanning + * @enum {string} + */ + secret_scanning: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning push protection + * @enum {string} + */ + secret_scanning_push_protection: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning validity checks + * @enum {string} + */ + secret_scanning_validity_checks: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning non-provider patterns + * @enum {string} + */ + secret_scanning_non_provider_patterns: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of private vulnerability reporting + * @enum {string} + */ + private_vulnerability_reporting: "enabled" | "disabled" | "not_set"; + /** + * @description The enforcement status for a security configuration + * @enum {string} + */ + enforcement: "enforced" | "unenforced"; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["code-security-configuration"]; + }; + }; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + }; + }; + "code-security/attach-enterprise-configuration": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The unique identifier of the code security configuration. */ + configuration_id: components["parameters"]["configuration-id"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** + * @description The type of repositories to attach the configuration to. `selected` means the configuration will be attached to only the repositories specified by `selected_repository_ids` + * @enum {string} + */ + scope: "all" | "all_without_configurations"; + }; + }; + }; + responses: { + 202: components["responses"]["accepted"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + }; + }; + "code-security/set-configuration-as-default-for-enterprise": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The unique identifier of the code security configuration. */ + configuration_id: components["parameters"]["configuration-id"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** + * @description Specify which types of repository this security configuration should be applied to by default. + * @enum {string} + */ + default_for_new_repos: "all" | "none" | "private_and_internal" | "public"; + }; + }; + }; + responses: { + /** @description Default successfully changed. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * @description Specifies which types of repository this security configuration is applied to by default. + * @enum {string} + */ + default_for_new_repos: "all" | "none" | "private_and_internal" | "public"; + configuration: components["schemas"]["code-security-configuration"]; + }; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "code-security/get-repositories-for-enterprise-configuration": { parameters: { query?: { - /** @description Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago. */ - since?: string; - /** @description Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed. */ - until?: string; - /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - page?: components["parameters"]["page"]; - /** @description The number of days of metrics to display per page (max 28). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: number; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + before?: components["parameters"]["pagination-before"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + after?: components["parameters"]["pagination-after"]; + /** @description A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned. + * + * Can be: `all`, `attached`, `attaching`, `removed`, `enforced`, `failed`, `updating`, `removed_by_enterprise` */ + status?: string; }; header?: never; path: { /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description The unique identifier of the code security configuration. */ + configuration_id: components["parameters"]["configuration-id"]; }; cookie?: never; }; @@ -87619,13 +88718,11 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["copilot-usage-metrics"][]; + "application/json": components["schemas"]["code-security-configuration-repositories"][]; }; }; - 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; }; }; "dependabot/list-alerts-for-enterprise": { @@ -87697,9 +88794,7 @@ export interface operations { query?: { /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ state?: components["parameters"]["secret-scanning-alert-state"]; - /** @description A comma-separated list of secret types to return. By default all secret types are returned. - * See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" - * for a complete list of secret types. */ + /** @description A comma-separated list of secret types to return. All default secret patterns are returned. To return experimental patterns, pass the token name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. */ secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ resolution?: components["parameters"]["secret-scanning-alert-resolution"]; @@ -87743,82 +88838,6 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - "copilot/copilot-metrics-for-enterprise-team": { - parameters: { - query?: { - /** @description Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago. */ - since?: string; - /** @description Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed. */ - until?: string; - /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - page?: components["parameters"]["page"]; - /** @description The number of days of metrics to display per page (max 28). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - per_page?: number; - }; - header?: never; - path: { - /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - /** @description The slug of the enterprise team name. */ - team_slug: components["parameters"]["enterprise-team-slug"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["copilot-usage-metrics-day"][]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["usage_metrics_api_disabled"]; - 500: components["responses"]["internal_error"]; - }; - }; - "copilot/usage-metrics-for-enterprise-team": { - parameters: { - query?: { - /** @description Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago. */ - since?: string; - /** @description Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed. */ - until?: string; - /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - page?: components["parameters"]["page"]; - /** @description The number of days of metrics to display per page (max 28). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - per_page?: number; - }; - header?: never; - path: { - /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - /** @description The slug of the team name. */ - team_slug: components["parameters"]["team-slug"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["copilot-usage-metrics"][]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; - }; - }; "activity/list-public-events": { parameters: { query?: { @@ -89271,6 +90290,34 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; + "billing/get-github-billing-usage-report-org": { + parameters: { + query?: { + /** @description If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2024`. Default value is the current year. */ + year?: components["parameters"]["billing-usage-report-year"]; + /** @description If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. */ + month?: components["parameters"]["billing-usage-report-month"]; + /** @description If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. */ + day?: components["parameters"]["billing-usage-report-day"]; + /** @description If specified, only return results for a single hour. The value of `hour` is an integer between `0` and `23`. */ + hour?: components["parameters"]["billing-usage-report-hour"]; + }; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["billing_usage_report_org"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 500: components["responses"]["internal_error"]; + 503: components["responses"]["service_unavailable"]; + }; + }; "orgs/get": { parameters: { query?: never; @@ -91166,6 +92213,7 @@ export interface operations { }; }; repository_id: number; + bundle_url: string; }[]; }; }; @@ -91421,6 +92469,7 @@ export interface operations { * @enum {string} */ code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; + code_scanning_default_setup_options?: components["schemas"]["code-scanning-default-setup-options"]; /** * @description The enablement status of secret scanning * @default disabled @@ -91646,6 +92695,7 @@ export interface operations { * @enum {string} */ code_scanning_default_setup: "enabled" | "disabled" | "not_set"; + code_scanning_default_setup_options: components["schemas"]["code-scanning-default-setup-options"]; /** * @description The enablement status of secret scanning * @enum {string} @@ -93373,10 +94423,10 @@ export interface operations { "api-insights/get-route-stats-by-actor": { parameters: { query: { - /** @description The minimum timestamp to query for stats */ + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ min_timestamp: components["parameters"]["api-insights-min-timestamp"]; - /** @description The maximum timestamp to query for stats */ - max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ @@ -93385,6 +94435,8 @@ export interface operations { direction?: components["parameters"]["direction"]; /** @description The property to sort the results by. */ sort?: components["parameters"]["api-insights-route-stats-sort"]; + /** @description Providing a substring will filter results where the API route contains the substring. This is a case-insensitive search. */ + api_route_substring?: components["parameters"]["api-insights-api-route-substring"]; }; header?: never; path: { @@ -93413,10 +94465,10 @@ export interface operations { "api-insights/get-subject-stats": { parameters: { query: { - /** @description The minimum timestamp to query for stats */ + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ min_timestamp: components["parameters"]["api-insights-min-timestamp"]; - /** @description The maximum timestamp to query for stats */ - max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ @@ -93425,6 +94477,8 @@ export interface operations { direction?: components["parameters"]["direction"]; /** @description The property to sort the results by. */ sort?: components["parameters"]["api-insights-sort"]; + /** @description Providing a substring will filter results where the subject name contains the substring. This is a case-insensitive search. */ + subject_name_substring?: components["parameters"]["api-insights-subject-name-substring"]; }; header?: never; path: { @@ -93449,10 +94503,10 @@ export interface operations { "api-insights/get-summary-stats": { parameters: { query: { - /** @description The minimum timestamp to query for stats */ + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ min_timestamp: components["parameters"]["api-insights-min-timestamp"]; - /** @description The maximum timestamp to query for stats */ - max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; }; header?: never; path: { @@ -93477,10 +94531,10 @@ export interface operations { "api-insights/get-summary-stats-by-user": { parameters: { query: { - /** @description The minimum timestamp to query for stats */ + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ min_timestamp: components["parameters"]["api-insights-min-timestamp"]; - /** @description The maximum timestamp to query for stats */ - max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; }; header?: never; path: { @@ -93507,10 +94561,10 @@ export interface operations { "api-insights/get-summary-stats-by-actor": { parameters: { query: { - /** @description The minimum timestamp to query for stats */ + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ min_timestamp: components["parameters"]["api-insights-min-timestamp"]; - /** @description The maximum timestamp to query for stats */ - max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; }; header?: never; path: { @@ -93539,10 +94593,10 @@ export interface operations { "api-insights/get-time-stats": { parameters: { query: { - /** @description The minimum timestamp to query for stats */ + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ min_timestamp: components["parameters"]["api-insights-min-timestamp"]; - /** @description The maximum timestamp to query for stats */ - max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; /** @description The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) */ timestamp_increment: components["parameters"]["api-insights-timestamp-increment"]; }; @@ -93569,10 +94623,10 @@ export interface operations { "api-insights/get-time-stats-by-user": { parameters: { query: { - /** @description The minimum timestamp to query for stats */ + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ min_timestamp: components["parameters"]["api-insights-min-timestamp"]; - /** @description The maximum timestamp to query for stats */ - max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; /** @description The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) */ timestamp_increment: components["parameters"]["api-insights-timestamp-increment"]; }; @@ -93601,10 +94655,10 @@ export interface operations { "api-insights/get-time-stats-by-actor": { parameters: { query: { - /** @description The minimum timestamp to query for stats */ + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ min_timestamp: components["parameters"]["api-insights-min-timestamp"]; - /** @description The maximum timestamp to query for stats */ - max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; /** @description The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) */ timestamp_increment: components["parameters"]["api-insights-timestamp-increment"]; }; @@ -93635,10 +94689,10 @@ export interface operations { "api-insights/get-user-stats": { parameters: { query: { - /** @description The minimum timestamp to query for stats */ + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ min_timestamp: components["parameters"]["api-insights-min-timestamp"]; - /** @description The maximum timestamp to query for stats */ - max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ @@ -93647,6 +94701,8 @@ export interface operations { direction?: components["parameters"]["direction"]; /** @description The property to sort the results by. */ sort?: components["parameters"]["api-insights-sort"]; + /** @description Providing a substring will filter results where the actor name contains the substring. This is a case-insensitive search. */ + actor_name_substring?: components["parameters"]["api-insights-actor-name-substring"]; }; header?: never; path: { @@ -95515,6 +96571,223 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; + "private-registries/list-org-private-registries": { + parameters: { + query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + page?: components["parameters"]["page"]; + }; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": { + total_count: number; + configurations: components["schemas"]["org-private-registry-configuration"][]; + }; + }; + }; + 400: components["responses"]["bad_request"]; + 404: components["responses"]["not_found"]; + }; + }; + "private-registries/create-org-private-registry": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** + * @description The registry type. + * @enum {string} + */ + registry_type: "maven_repository"; + /** @description The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication. */ + username?: string | null; + /** @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint. */ + encrypted_value: string; + /** @description The ID of the key you used to encrypt the secret. */ + key_id: string; + /** + * @description Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry. + * @enum {string} + */ + visibility: "all" | "private" | "selected"; + /** @description An array of repository IDs that can access the organization private registry. You can only provide a list of repository IDs when `visibility` is set to `selected`. You can manage the list of selected repositories using the [Update a private registry for an organization](https://docs.github.com/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization) endpoint. This field should be omitted if `visibility` is set to `all` or `private`. */ + selected_repository_ids?: number[]; + }; + }; + }; + responses: { + /** @description The organization private registry configuration */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["org-private-registry-configuration-with-selected-repositories"]; + }; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "private-registries/get-org-public-key": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * @description The identifier for the key. + * @example 012345678912345678 + */ + key_id: string; + /** + * @description The Base64 encoded public key. + * @example 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 + */ + key: string; + }; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + "private-registries/get-org-private-registry": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The name of the secret. */ + secret_name: components["parameters"]["secret-name"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description The specified private registry configuration for the organization */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["org-private-registry-configuration"]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + "private-registries/delete-org-private-registry": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The name of the secret. */ + secret_name: components["parameters"]["secret-name"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 400: components["responses"]["bad_request"]; + 404: components["responses"]["not_found"]; + }; + }; + "private-registries/update-org-private-registry": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The name of the secret. */ + secret_name: components["parameters"]["secret-name"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** + * @description The registry type. + * @enum {string} + */ + registry_type: "maven_repository"; + /** @description The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication. */ + username: string | null; + /** @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint. */ + encrypted_value: string; + /** @description The ID of the key you used to encrypt the secret. */ + key_id: string; + /** + * @description Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry. + * @enum {string} + */ + visibility: "all" | "private" | "selected"; + /** @description An array of repository IDs that can access the organization private registry. You can only provide a list of repository IDs when `visibility` is set to `selected`. This field should be omitted if `visibility` is set to `all` or `private`. */ + selected_repository_ids: number[]; + }; + }; + }; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; "projects/list-for-org": { parameters: { query?: { @@ -95682,23 +96955,7 @@ export interface operations { }; requestBody: { content: { - "application/json": { - /** - * @description The type of the value for the property - * @example single_select - * @enum {string} - */ - value_type: "string" | "single_select" | "multi_select" | "true_false"; - /** @description Whether the property is required. */ - required?: boolean; - /** @description Default value of the property */ - default_value?: (string | string[]) | null; - /** @description Short description of the property */ - description?: string | null; - /** @description An ordered list of the allowed values of the property. - * The property can have up to 200 allowed values. */ - allowed_values?: string[] | null; - }; + "application/json": components["schemas"]["custom-property-set-payload"]; }; }; responses: { @@ -96155,7 +97412,7 @@ export interface operations { * @default branch * @enum {string} */ - target?: "branch" | "tag" | "push"; + target?: "branch" | "tag" | "push" | "repository"; enforcement: components["schemas"]["repository-rule-enforcement"]; /** @description The actors that can bypass the rules in this ruleset */ bypass_actors?: components["schemas"]["repository-ruleset-bypass-actor"][]; @@ -96184,7 +97441,7 @@ export interface operations { query?: { /** @description The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. */ ref?: components["parameters"]["ref-in-query"]; - /** @description The name of the repository to filter on. When specified, only rule evaluations from this repository will be returned. */ + /** @description The name of the repository to filter on. */ repository_name?: components["parameters"]["repository-name-in-query"]; /** @description The time period to filter by. * @@ -96300,7 +97557,7 @@ export interface operations { * @description The target of the ruleset * @enum {string} */ - target: "branch" | "tag" | "push"; + target: "branch" | "tag" | "push" | "repository"; enforcement: components["schemas"]["repository-rule-enforcement"]; /** @description The actors that can bypass the rules in this ruleset */ bypass_actors: components["schemas"]["repository-ruleset-bypass-actor"][]; @@ -96354,9 +97611,7 @@ export interface operations { query?: { /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ state?: components["parameters"]["secret-scanning-alert-state"]; - /** @description A comma-separated list of secret types to return. By default all secret types are returned. - * See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" - * for a complete list of secret types. */ + /** @description A comma-separated list of secret types to return. All default secret patterns are returned. To return experimental patterns, pass the token name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. */ secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ resolution?: components["parameters"]["secret-scanning-alert-resolution"]; @@ -101375,6 +102630,7 @@ export interface operations { }; }; repository_id: number; + bundle_url: string; }[]; }; }; @@ -103463,6 +104719,126 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; + "code-scanning/get-autofix": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The account owner of the repository. The name is not case sensitive. */ + owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ + repo: components["parameters"]["repo"]; + /** @description The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */ + alert_number: components["parameters"]["alert-number"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["code-scanning-autofix"]; + }; + }; + 400: components["responses"]["code_scanning_bad_request"]; + 403: components["responses"]["code_scanning_forbidden_read"]; + 404: components["responses"]["not_found"]; + 503: components["responses"]["service_unavailable"]; + }; + }; + "code-scanning/create-autofix": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The account owner of the repository. The name is not case sensitive. */ + owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ + repo: components["parameters"]["repo"]; + /** @description The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */ + alert_number: components["parameters"]["alert-number"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["code-scanning-autofix"]; + }; + }; + /** @description Accepted */ + 202: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["code-scanning-autofix"]; + }; + }; + 400: components["responses"]["code_scanning_bad_request"]; + 403: components["responses"]["code_scanning_autofix_create_forbidden"]; + 404: components["responses"]["not_found"]; + /** @description Unprocessable Entity */ + 422: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 503: components["responses"]["service_unavailable"]; + }; + }; + "code-scanning/commit-autofix": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The account owner of the repository. The name is not case sensitive. */ + owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ + repo: components["parameters"]["repo"]; + /** @description The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */ + alert_number: components["parameters"]["alert-number"]; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": components["schemas"]["code-scanning-autofix-commits"]; + }; + }; + responses: { + /** @description Created */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["code-scanning-autofix-commits-response"]; + }; + }; + 400: components["responses"]["code_scanning_bad_request"]; + 403: components["responses"]["code_scanning_forbidden_write"]; + 404: components["responses"]["not_found"]; + /** @description Unprocessable Entity */ + 422: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 503: components["responses"]["service_unavailable"]; + }; + }; "code-scanning/list-alert-instances": { parameters: { query?: { @@ -109679,6 +111055,163 @@ export interface operations { }; }; }; + "issues/remove-sub-issue": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The account owner of the repository. The name is not case sensitive. */ + owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ + repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ + issue_number: components["parameters"]["issue-number"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description The sub-issue to remove */ + sub_issue_id: number; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + /** @example https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue */ + Location?: string; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["issue"]; + }; + }; + 400: components["responses"]["bad_request"]; + 404: components["responses"]["not_found"]; + }; + }; + "issues/list-sub-issues": { + parameters: { + query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + page?: components["parameters"]["page"]; + }; + header?: never; + path: { + /** @description The account owner of the repository. The name is not case sensitive. */ + owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ + repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ + issue_number: components["parameters"]["issue-number"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["issue"][]; + }; + }; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; + }; + }; + "issues/add-sub-issue": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The account owner of the repository. The name is not case sensitive. */ + owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ + repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ + issue_number: components["parameters"]["issue-number"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description The sub-issue to add */ + sub_issue_id: number; + /** @description Option that, when true, instructs the operation to replace the sub-issues current parent issue */ + replace_parent?: boolean; + }; + }; + }; + responses: { + /** @description Response */ + 201: { + headers: { + /** @example https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1 */ + Location?: string; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["issue"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "issues/reprioritize-sub-issue": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The account owner of the repository. The name is not case sensitive. */ + owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ + repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ + issue_number: components["parameters"]["issue-number"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description The id of the sub-issue to reprioritize */ + sub_issue_id: number; + /** @description The id of the sub-issue to be prioritized after (either positional argument after OR before should be specified). */ + after_id?: number; + /** @description The id of the sub-issue to be prioritized before (either positional argument after OR before should be specified). */ + before_id?: number; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["issue"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed_simple"]; + 503: components["responses"]["service_unavailable"]; + }; + }; "issues/list-events-for-timeline": { parameters: { query?: { @@ -113291,9 +114824,7 @@ export interface operations { query?: { /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ state?: components["parameters"]["secret-scanning-alert-state"]; - /** @description A comma-separated list of secret types to return. By default all secret types are returned. - * See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" - * for a complete list of secret types. */ + /** @description A comma-separated list of secret types to return. All default secret patterns are returned. To return experimental patterns, pass the token name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. */ secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ resolution?: components["parameters"]["secret-scanning-alert-resolution"]; @@ -113534,6 +115065,39 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; + "secret-scanning/get-scan-history": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The account owner of the repository. The name is not case sensitive. */ + owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ + repo: components["parameters"]["repo"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["secret-scanning-scan-history"]; + }; + }; + /** @description Repository does not have GitHub Advanced Security or secret scanning enabled */ + 404: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 503: components["responses"]["service_unavailable"]; + }; + }; "security-advisories/list-repository-advisories": { parameters: { query?: { @@ -119189,6 +120753,7 @@ export interface operations { attestations: { bundle: components["schemas"]["sigstore-bundle-0"]; repository_id: number; + bundle_url: string; }[]; }; }; diff --git a/packages/openapi-typescript/examples/github-api-root-types.ts b/packages/openapi-typescript/examples/github-api-root-types.ts index c2a9cdbee..c08439d82 100644 --- a/packages/openapi-typescript/examples/github-api-root-types.ts +++ b/packages/openapi-typescript/examples/github-api-root-types.ts @@ -289,8 +289,6 @@ export interface paths { * * Optionally, use the `permissions` body parameter to specify the permissions that the installation access token should have. If `permissions` is not specified, the installation access token will have all of the permissions that were granted to the app. The installation access token cannot be granted permissions that the app was not granted. * - * When using the repository or permission parameters to reduce the access of the token, the complexity of the token is increased due to both the number of permissions in the request and the number of repositories the token will have access to. If the complexity is too large, the token will fail to be issued. If this occurs, the error message will indicate the maximum number of repositories that should be requested. For the average application requesting 8 permissions, this limit is around 5000 repositories. With fewer permissions requested, more repositories are supported. - * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ post: operations["apps/create-installation-access-token"]; @@ -602,7 +600,7 @@ export interface paths { patch?: never; trace?: never; }; - "/enterprises/{enterprise}/copilot/billing/seats": { + "/enterprises/{enterprise}/code-security/configurations": { parameters: { query?: never; header?: never; @@ -610,33 +608,31 @@ export interface paths { cookie?: never; }; /** - * List all Copilot seat assignments for an enterprise - * @description > [!NOTE] - * > This endpoint is in public preview and is subject to change. + * Get code security configurations for an enterprise + * @description Lists all code security configurations available in an enterprise. * - * Lists all Copilot seats currently being billed for across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription. + * The authenticated user must be an administrator of the enterprise in order to use this endpoint. * - * Users with access through multiple organizations or enterprise teams will only be counted toward `total_seats` once. - * - * For each organization or enterprise team which grants Copilot access to a user, a seat detail object will appear in the `seats` array. - * Each seat object contains information about the assigned user's most recent Copilot activity. Users must have - * telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. For more information about activity data, - * see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." + * OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. + */ + get: operations["code-security/get-configurations-for-enterprise"]; + put?: never; + /** + * Create a code security configuration for an enterprise + * @description Creates a code security configuration in an enterprise. * - * Only enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams. + * The authenticated user must be an administrator of the enterprise in order to use this endpoint. * - * Personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ - get: operations["copilot/list-copilot-seats-for-enterprise"]; - put?: never; - post?: never; + post: operations["code-security/create-configuration-for-enterprise"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/enterprises/{enterprise}/copilot/metrics": { + "/enterprises/{enterprise}/code-security/configurations/defaults": { parameters: { query?: never; header?: never; @@ -644,19 +640,14 @@ export interface paths { cookie?: never; }; /** - * Get Copilot metrics for an enterprise - * @description Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. - * - * The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, - * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, - * they must have telemetry enabled in their IDE. + * Get default code security configurations for an enterprise + * @description Lists the default code security configurations for an enterprise. * - * To access this endpoint, the Copilot Metrics API access policy must be enabled or set to "no policy" for the enterprise within GitHub settings. - * Only enterprise owners and billing managers can view Copilot metrics for the enterprise. + * The authenticated user must be an administrator of the enterprise in order to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. */ - get: operations["copilot/copilot-metrics-for-enterprise"]; + get: operations["code-security/get-default-configurations-for-enterprise"]; put?: never; post?: never; delete?: never; @@ -665,7 +656,7 @@ export interface paths { patch?: never; trace?: never; }; - "/enterprises/{enterprise}/copilot/usage": { + "/enterprises/{enterprise}/code-security/configurations/{configuration_id}": { parameters: { query?: never; header?: never; @@ -673,52 +664,85 @@ export interface paths { cookie?: never; }; /** - * Get a summary of Copilot usage for enterprise members - * @description > [!NOTE] - * > This endpoint is in public preview and is subject to change. + * Retrieve a code security configuration of an enterprise + * @description Gets a code security configuration available in an enterprise. * - * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE - * for all users across organizations with access to Copilot within your enterprise, with a further breakdown of suggestions, acceptances, - * and number of active users by editor and language for each day. See the response schema tab for detailed metrics definitions. + * The authenticated user must be an administrator of the enterprise in order to use this endpoint. * - * The response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day, - * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, - * they must have telemetry enabled in their IDE. + * OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. + */ + get: operations["code-security/get-single-configuration-for-enterprise"]; + put?: never; + post?: never; + /** + * Delete a code security configuration for an enterprise + * @description Deletes a code security configuration from an enterprise. + * Repositories attached to the configuration will retain their settings but will no longer be associated with + * the configuration. + * + * The authenticated user must be an administrator for the enterprise to use this endpoint. * - * The time zone in the response is in UTC time, that means that the cutoff time for the "day" is UTC time. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + */ + delete: operations["code-security/delete-configuration-for-enterprise"]; + options?: never; + head?: never; + /** + * Update a custom code security configuration for an enterprise + * @description Updates a code security configuration in an enterprise. * - * Only owners and billing managers can view Copilot usage metrics for the enterprise. + * The authenticated user must be an administrator of the enterprise in order to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ - get: operations["copilot/usage-metrics-for-enterprise"]; + patch: operations["code-security/update-enterprise-configuration"]; + trace?: never; + }; + "/enterprises/{enterprise}/code-security/configurations/{configuration_id}/attach": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; put?: never; - post?: never; + /** + * Attach an enterprise configuration to repositories + * @description Attaches an enterprise code security configuration to repositories. If the repositories specified are already attached to a configuration, they will be re-attached to the provided configuration. + * + * If insufficient GHAS licenses are available to attach the configuration to a repository, only free features will be enabled. + * + * The authenticated user must be an administrator for the enterprise to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + */ + post: operations["code-security/attach-enterprise-configuration"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/enterprises/{enterprise}/dependabot/alerts": { + "/enterprises/{enterprise}/code-security/configurations/{configuration_id}/defaults": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; + get?: never; /** - * List Dependabot alerts for an enterprise - * @description Lists Dependabot alerts for repositories that are owned by the specified enterprise. + * Set a code security configuration as a default for an enterprise + * @description Sets a code security configuration as a default to be applied to new repositories in your enterprise. * - * The authenticated user must be a member of the enterprise to use this endpoint. + * This configuration will be applied by default to the matching repository type when created, but only for organizations within the enterprise that do not already have a default code security configuration set. * - * Alerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager. For more information about security managers, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * The authenticated user must be an administrator for the enterprise to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ - get: operations["dependabot/list-alerts-for-enterprise"]; - put?: never; + put: operations["code-security/set-configuration-as-default-for-enterprise"]; post?: never; delete?: never; options?: never; @@ -726,7 +750,7 @@ export interface paths { patch?: never; trace?: never; }; - "/enterprises/{enterprise}/secret-scanning/alerts": { + "/enterprises/{enterprise}/code-security/configurations/{configuration_id}/repositories": { parameters: { query?: never; header?: never; @@ -734,16 +758,14 @@ export interface paths { cookie?: never; }; /** - * List secret scanning alerts for an enterprise - * @description Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest. - * - * Alerts are only returned for organizations in the enterprise for which the authenticated user is an organization owner or a [security manager](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization). + * Get repositories associated with an enterprise code security configuration + * @description Lists the repositories associated with an enterprise code security configuration in an organization. * - * The authenticated user must be a member of the enterprise in order to use this endpoint. + * The authenticated user must be an administrator of the enterprise in order to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope or `security_events` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. */ - get: operations["secret-scanning/list-alerts-for-enterprise"]; + get: operations["code-security/get-repositories-for-enterprise-configuration"]; put?: never; post?: never; delete?: never; @@ -752,7 +774,7 @@ export interface paths { patch?: never; trace?: never; }; - "/enterprises/{enterprise}/team/{team_slug}/copilot/metrics": { + "/enterprises/{enterprise}/dependabot/alerts": { parameters: { query?: never; header?: never; @@ -760,22 +782,16 @@ export interface paths { cookie?: never; }; /** - * Get Copilot metrics for an enterprise team - * @description Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. - * - * The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, - * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, - * they must have telemetry enabled in their IDE. + * List Dependabot alerts for an enterprise + * @description Lists Dependabot alerts for repositories that are owned by the specified enterprise. * - * > [!NOTE] - * > This endpoint will only return results for a given day if the enterprise team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day. + * The authenticated user must be a member of the enterprise to use this endpoint. * - * To access this endpoint, the Copilot Metrics API access policy must be enabled or set to "no policy" for the enterprise within GitHub settings. - * Only owners and billing managers for the enterprise that contains the enterprise team can view Copilot metrics for the enterprise team. + * Alerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager. For more information about security managers, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. */ - get: operations["copilot/copilot-metrics-for-enterprise-team"]; + get: operations["dependabot/list-alerts-for-enterprise"]; put?: never; post?: never; delete?: never; @@ -784,7 +800,7 @@ export interface paths { patch?: never; trace?: never; }; - "/enterprises/{enterprise}/team/{team_slug}/copilot/usage": { + "/enterprises/{enterprise}/secret-scanning/alerts": { parameters: { query?: never; header?: never; @@ -792,26 +808,16 @@ export interface paths { cookie?: never; }; /** - * Get a summary of Copilot usage for an enterprise team - * @description > [!NOTE] - * > This endpoint is in public preview and is subject to change. - * - * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE - * for users within an enterprise team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day. - * See the response schema tab for detailed metrics definitions. - * - * The response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day, - * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, - * they must have telemetry enabled in their IDE. + * List secret scanning alerts for an enterprise + * @description Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest. * - * > [!NOTE] - * > This endpoint will only return results for a given day if the enterprise team had five or more members with active Copilot licenses, as evaluated at the end of that day. + * Alerts are only returned for organizations in the enterprise for which the authenticated user is an organization owner or a [security manager](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization). * - * Owners and billing managers for the enterprise that contains the enterprise team can view Copilot usage metrics for the enterprise team. + * The authenticated user must be a member of the enterprise in order to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope or `security_events` scope to use this endpoint. */ - get: operations["copilot/usage-metrics-for-enterprise-team"]; + get: operations["secret-scanning/list-alerts-for-enterprise"]; put?: never; post?: never; delete?: never; @@ -1637,6 +1643,28 @@ export interface paths { patch?: never; trace?: never; }; + "/organizations/{org}/settings/billing/usage": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get billing usage report for an organization + * @description Gets a report of the total usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account. + * + * **Note:** This endpoint is only available to organizations with access to the enhanced billing platform. For more information, see "[About the enhanced billing platform](https://docs.github.com/billing/using-the-new-billing-platform)." + */ + get: operations["billing/get-github-billing-usage-report-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/orgs/{org}": { parameters: { query?: never; @@ -3217,13 +3245,11 @@ export interface paths { * Purchases a GitHub Copilot seat for all users within each specified team. * The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." * - * Only organization owners can add Copilot seats for their organization members. - * - * In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy. + * Only organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy. * For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." * For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." * - * The response will contain the total number of new seats that were created and existing seats that were refreshed. + * The response contains the total number of new seats that were created and existing seats that were refreshed. * * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. */ @@ -3235,14 +3261,11 @@ export interface paths { * * Sets seats for all members of each team specified to "pending cancellation". * This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team. - * - * For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." - * - * For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." + * For more information about disabling access to Copilot, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." * * Only organization owners can cancel Copilot seats for their organization members. * - * The response will contain the total number of seats set to "pending cancellation". + * The response contains the total number of seats set to "pending cancellation". * * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. */ @@ -3269,13 +3292,11 @@ export interface paths { * Purchases a GitHub Copilot seat for each user specified. * The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." * - * Only organization owners can add Copilot seats for their organization members. - * - * In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy. + * Only organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy. * For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." * For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." * - * The response will contain the total number of new seats that were created and existing seats that were refreshed. + * The response contains the total number of new seats that were created and existing seats that were refreshed. * * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. */ @@ -3287,14 +3308,11 @@ export interface paths { * * Sets seats for all users specified to "pending cancellation". * This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership. - * - * For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." - * - * For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." + * For more information about disabling access to Copilot, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." * * Only organization owners can cancel Copilot seats for their organization members. * - * The response will contain the total number of seats set to "pending cancellation". + * The response contains the total number of seats set to "pending cancellation". * * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. */ @@ -3609,7 +3627,9 @@ export interface paths { }; /** * List organization webhooks - * @description You must be an organization owner to use this endpoint. + * @description List webhooks for an organization. + * + * The authenticated user must be an organization owner to use this endpoint. * * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. @@ -3654,7 +3674,9 @@ export interface paths { post?: never; /** * Delete an organization webhook - * @description You must be an organization owner to use this endpoint. + * @description Delete a webhook for an organization. + * + * The authenticated user must be an organization owner to use this endpoint. * * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. @@ -5027,6 +5049,109 @@ export interface paths { patch?: never; trace?: never; }; + "/orgs/{org}/private-registries": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List private registries for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Lists all private registry configurations available at the organization-level without revealing their encrypted + * values. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + get: operations["private-registries/list-org-private-registries"]; + put?: never; + /** + * Create a private registry for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Creates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + post: operations["private-registries/create-org-private-registry"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/private-registries/public-key": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get private registries public key for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Gets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets. + * + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + get: operations["private-registries/get-org-public-key"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/private-registries/{secret_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get a private registry for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Get the configuration of a single private registry defined for an organization, omitting its encrypted value. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + get: operations["private-registries/get-org-private-registry"]; + put?: never; + post?: never; + /** + * Delete a private registry for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Delete a private registry configuration at the organization-level. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + delete: operations["private-registries/delete-org-private-registry"]; + options?: never; + head?: never; + /** + * Update a private registry for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + patch: operations["private-registries/update-org-private-registry"]; + trace?: never; + }; "/orgs/{org}/projects": { parameters: { query?: never; @@ -5384,11 +5509,9 @@ export interface paths { }; /** * List security manager teams - * @description Lists teams that are security managers for an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." - * - * The authenticated user must be an administrator or security manager for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the "[Organization Roles](https://docs.github.com/rest/orgs/organization-roles)" endpoints instead. */ get: operations["orgs/list-security-manager-teams"]; put?: never; @@ -5409,21 +5532,17 @@ export interface paths { get?: never; /** * Add a security manager team - * @description Adds a team as a security manager for an organization. For more information, see "[Managing security for an organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) for an organization." - * - * The authenticated user must be an administrator for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the "[Organization Roles](https://docs.github.com/rest/orgs/organization-roles)" endpoints instead. */ put: operations["orgs/add-security-manager-team"]; post?: never; /** * Remove a security manager team - * @description Removes the security manager role from a team for an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) team from an organization." - * - * The authenticated user must be an administrator for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the "[Organization Roles](https://docs.github.com/rest/orgs/organization-roles)" endpoints instead. */ delete: operations["orgs/remove-security-manager-team"]; options?: never; @@ -7166,7 +7285,7 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. * - * This API will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`. + * This endpoint will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`. */ get: operations["actions/list-workflow-runs-for-repo"]; put?: never; @@ -7871,6 +7990,8 @@ export interface paths { * Anyone with read access to the repository can use this endpoint * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * + * This endpoint will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`. */ get: operations["actions/list-workflow-runs"]; put?: never; @@ -8806,6 +8927,62 @@ export interface paths { patch: operations["code-scanning/update-alert"]; trace?: never; }; + "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/autofix": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get the status of an autofix for a code scanning alert + * @description Gets the status and description of an autofix for a code scanning alert. + * + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + */ + get: operations["code-scanning/get-autofix"]; + put?: never; + /** + * Create an autofix for a code scanning alert + * @description Creates an autofix for a code scanning alert. + * + * If a new autofix is to be created as a result of this request or is currently being generated, then this endpoint will return a 202 Accepted response. + * + * If an autofix already exists for a given alert, then this endpoint will return a 200 OK response. + * + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + */ + post: operations["code-scanning/create-autofix"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/autofix/commits": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Commit an autofix for a code scanning alert + * @description Commits an autofix for a code scanning alert. + * + * If an autofix is commited as a result of this request, then this endpoint will return a 201 Created response. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + */ + post: operations["code-scanning/commit-autofix"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances": { parameters: { query?: never; @@ -9700,6 +9877,7 @@ export interface paths { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -9842,6 +10020,7 @@ export interface paths { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -10042,6 +10221,7 @@ export interface paths { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -11026,6 +11206,7 @@ export interface paths { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -11075,6 +11256,7 @@ export interface paths { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -11220,6 +11402,7 @@ export interface paths { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -11265,6 +11448,7 @@ export interface paths { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -11381,7 +11565,12 @@ export interface paths { get: operations["repos/get-webhook"]; put?: never; post?: never; - /** Delete a repository webhook */ + /** + * Delete a repository webhook + * @description Delete a webhook for an organization. + * + * The authenticated user must be a repository owner, or have admin access in the repository, to delete the webhook. + */ delete: operations["repos/delete-webhook"]; options?: never; head?: never; @@ -12288,6 +12477,96 @@ export interface paths { patch?: never; trace?: never; }; + "/repos/{owner}/{repo}/issues/{issue_number}/sub_issue": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + /** + * Remove sub-issue + * @description You can use the REST API to remove a sub-issue from an issue. + * Removing content too quickly using this endpoint may result in secondary rate limiting. + * For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass a specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + */ + delete: operations["issues/remove-sub-issue"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/issues/{issue_number}/sub_issues": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List sub-issues + * @description You can use the REST API to list the sub-issues on an issue. + * + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + */ + get: operations["issues/list-sub-issues"]; + put?: never; + /** + * Add sub-issue + * @description You can use the REST API to add sub-issues to issues. + * + * Creating content too quickly using this endpoint may result in secondary rate limiting. + * For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + * + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + */ + post: operations["issues/add-sub-issue"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/issues/{issue_number}/sub_issues/priority": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + /** + * Reprioritize sub-issue + * @description You can use the REST API to reprioritize a sub-issue to a different position in the parent list. + */ + patch: operations["issues/reprioritize-sub-issue"]; + trace?: never; + }; "/repos/{owner}/{repo}/issues/{issue_number}/timeline": { parameters: { query?: never; @@ -13586,7 +13865,13 @@ export interface paths { }; /** * Get a release asset - * @description To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response. + * @description To download the asset's binary content: + * + * - If within a browser, fetch the location specified in the `browser_download_url` key provided in the response. + * - Alternatively, set the `Accept` header of the request to + * [`application/octet-stream`](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + * The API will either redirect the client to the location, or stream it directly if possible. + * API clients should handle both a `200` or `302` response. */ get: operations["repos/get-release-asset"]; put?: never; @@ -14005,6 +14290,28 @@ export interface paths { patch?: never; trace?: never; }; + "/repos/{owner}/{repo}/secret-scanning/scan-history": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get secret scanning scan history for a repository + * @description Lists the latest incremental and backfill scans by type for a repository. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + */ + get: operations["secret-scanning/get-scan-history"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/repos/{owner}/{repo}/security-advisories": { parameters: { query?: never; @@ -19792,521 +20099,146 @@ export interface components { /** Format: uri */ html_url: string | null; }; - /** - * Organization Simple - * @description A GitHub organization. - */ - "nullable-organization-simple": { - /** @example github */ - login: string; - /** @example 1 */ - id: number; - /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ - node_id: string; + /** @description A code security configuration */ + "code-security-configuration": { + /** @description The ID of the code security configuration */ + id?: number; + /** @description The name of the code security configuration. Must be unique within the organization. */ + name?: string; /** - * Format: uri - * @example https://api.github.com/orgs/github + * @description The type of the code security configuration. + * @enum {string} */ - url: string; + target_type?: "global" | "organization" | "enterprise"; + /** @description A description of the code security configuration */ + description?: string; /** - * Format: uri - * @example https://api.github.com/orgs/github/repos + * @description The enablement status of GitHub Advanced Security + * @enum {string} */ - repos_url: string; + advanced_security?: "enabled" | "disabled"; /** - * Format: uri - * @example https://api.github.com/orgs/github/events + * @description The enablement status of Dependency Graph + * @enum {string} */ - events_url: string; - /** @example https://api.github.com/orgs/github/hooks */ - hooks_url: string; - /** @example https://api.github.com/orgs/github/issues */ - issues_url: string; - /** @example https://api.github.com/orgs/github/members{/member} */ - members_url: string; - /** @example https://api.github.com/orgs/github/public_members{/member} */ - public_members_url: string; - /** @example https://github.com/images/error/octocat_happy.gif */ - avatar_url: string; - /** @example A great organization */ - description: string | null; - } | null; - /** - * Team Simple - * @description Groups of organization members that gives permissions on specified repositories. - */ - "nullable-team-simple": { + dependency_graph?: "enabled" | "disabled" | "not_set"; /** - * @description Unique identifier of the team - * @example 1 + * @description The enablement status of Automatic dependency submission + * @enum {string} */ - id: number; - /** @example MDQ6VGVhbTE= */ - node_id: string; + dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for Automatic dependency submission */ + dependency_graph_autosubmit_action_options?: { + /** @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. */ + labeled_runners?: boolean; + }; /** - * Format: uri - * @description URL for the team - * @example https://api.github.com/organizations/1/team/1 + * @description The enablement status of Dependabot alerts + * @enum {string} */ - url: string; - /** @example https://api.github.com/organizations/1/team/1/members{/member} */ - members_url: string; + dependabot_alerts?: "enabled" | "disabled" | "not_set"; /** - * @description Name of the team - * @example Justice League + * @description The enablement status of Dependabot security updates + * @enum {string} */ - name: string; + dependabot_security_updates?: "enabled" | "disabled" | "not_set"; /** - * @description Description of the team - * @example A great team. + * @description The enablement status of code scanning default setup + * @enum {string} */ - description: string | null; + code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for code scanning default setup */ + code_scanning_default_setup_options?: { + /** + * @description Whether to use labeled runners or standard GitHub runners. + * @enum {string|null} + */ + runner_type?: "standard" | "labeled" | "not_set" | null; + /** @description The label of the runner to use for code scanning when runner_type is 'labeled'. */ + runner_label?: string | null; + } | null; /** - * @description Permission that the team will have for its repositories - * @example admin + * @description The enablement status of secret scanning + * @enum {string} */ - permission: string; + secret_scanning?: "enabled" | "disabled" | "not_set"; /** - * @description The level of privacy this team should have - * @example closed + * @description The enablement status of secret scanning push protection + * @enum {string} */ - privacy?: string; + secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; /** - * @description The notification setting the team has set - * @example notifications_enabled + * @description The enablement status of secret scanning delegated bypass + * @enum {string} */ - notification_setting?: string; + secret_scanning_delegated_bypass?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for secret scanning delegated bypass */ + secret_scanning_delegated_bypass_options?: { + /** @description The bypass reviewers for secret scanning delegated bypass */ + reviewers?: { + /** @description The ID of the team or role selected as a bypass reviewer */ + reviewer_id: number; + /** + * @description The type of the bypass reviewer + * @enum {string} + */ + reviewer_type: "TEAM" | "ROLE"; + }[]; + }; /** - * Format: uri - * @example https://github.com/orgs/rails/teams/core + * @description The enablement status of secret scanning validity checks + * @enum {string} */ - html_url: string; + secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; /** - * Format: uri - * @example https://api.github.com/organizations/1/team/1/repos + * @description The enablement status of secret scanning non-provider patterns + * @enum {string} */ - repositories_url: string; - /** @example justice-league */ - slug: string; + secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set"; /** - * @description Distinguished Name (DN) that team maps to within LDAP environment - * @example uid=example,ou=users,dc=github,dc=com + * @description The enablement status of private vulnerability reporting + * @enum {string} */ - ldap_dn?: string; - } | null; - /** - * Team - * @description Groups of organization members that gives permissions on specified repositories. - */ - team: { - id: number; - node_id: string; - name: string; - slug: string; - description: string | null; - privacy?: string; - notification_setting?: string; - permission: string; - permissions?: { - pull: boolean; - triage: boolean; - push: boolean; - maintain: boolean; - admin: boolean; - }; - /** Format: uri */ - url: string; + private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; + /** + * @description The enforcement status for a security configuration + * @enum {string} + */ + enforcement?: "enforced" | "unenforced"; /** * Format: uri - * @example https://github.com/orgs/rails/teams/core + * @description The URL of the configuration */ - html_url: string; - members_url: string; - /** Format: uri */ - repositories_url: string; - parent: components["schemas"]["nullable-team-simple"]; - }; - /** - * Enterprise Team - * @description Group of enterprise owners and/or members - */ - "enterprise-team": { - /** Format: int64 */ - id: number; - name: string; - slug: string; - /** Format: uri */ - url: string; - /** @example disabled | all */ - sync_to_organizations: string; - /** @example 62ab9291-fae2-468e-974b-7e45096d5021 */ - group_id?: string | null; + url?: string; /** * Format: uri - * @example https://github.com/enterprises/dc/teams/justice-league + * @description The URL of the configuration */ - html_url: string; - members_url: string; + html_url?: string; /** Format: date-time */ - created_at: string; + created_at?: string; /** Format: date-time */ - updated_at: string; - }; - /** - * Copilot Business Seat Detail - * @description Information about a Copilot Business seat assignment for a user, team, or organization. - */ - "copilot-seat-details": { - assignee: components["schemas"]["simple-user"]; - organization?: components["schemas"]["nullable-organization-simple"]; - /** @description The team through which the assignee is granted access to GitHub Copilot, if applicable. */ - assigning_team?: (components["schemas"]["team"] | components["schemas"]["enterprise-team"]) | null; - /** - * Format: date - * @description The pending cancellation date for the seat, in `YYYY-MM-DD` format. This will be null unless the assignee's Copilot access has been canceled during the current billing cycle. If the seat has been cancelled, this corresponds to the start of the organization's next billing cycle. - */ - pending_cancellation_date?: string | null; - /** - * Format: date-time - * @description Timestamp of user's last GitHub Copilot activity, in ISO 8601 format. - */ - last_activity_at?: string | null; - /** @description Last editor that was used by the user for a GitHub Copilot completion. */ - last_activity_editor?: string | null; - /** - * Format: date-time - * @description Timestamp of when the assignee was last granted access to GitHub Copilot, in ISO 8601 format. - */ - created_at: string; - /** - * Format: date-time - * @description Timestamp of when the assignee's GitHub Copilot access was last updated, in ISO 8601 format. - */ updated_at?: string; - /** - * @description The Copilot plan of the organization, or the parent enterprise, when applicable. - * @enum {string} - */ - plan_type?: "business" | "enterprise" | "unknown"; }; - /** @description Usage metrics for Copilot editor code completions in the IDE. */ - "copilot-ide-code-completions": ({ - /** @description Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances. */ - total_engaged_users?: number; - /** @description Code completion metrics for active languages. */ - languages?: { - /** @description Name of the language used for Copilot code completion suggestions. */ - name?: string; - /** @description Number of users who accepted at least one Copilot code completion suggestion for the given language. Includes both full and partial acceptances. */ - total_engaged_users?: number; - }[]; - editors?: ({ - /** @description Name of the given editor. */ - name?: string; - /** @description Number of users who accepted at least one Copilot code completion suggestion for the given editor. Includes both full and partial acceptances. */ - total_engaged_users?: number; - /** @description List of model metrics for custom models and the default model. */ - models?: { - /** @description Name of the language used for Copilot code completion suggestions, for the given editor. */ - name?: string; - /** @description Indicates whether a model is custom or default. */ - is_custom_model?: boolean; - /** @description The training date for the custom model. */ - custom_model_training_date?: string | null; - /** @description Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances. */ - total_engaged_users?: number; - /** @description Code completion metrics for active languages, for the given editor. */ - languages?: { - /** @description Name of the language used for Copilot code completion suggestions, for the given editor. */ - name?: string; - /** @description Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language. Includes both full and partial acceptances. */ - total_engaged_users?: number; - /** @description The number of Copilot code suggestions generated for the given editor, for the given language. */ - total_code_suggestions?: number; - /** @description The number of Copilot code suggestions accepted for the given editor, for the given language. Includes both full and partial acceptances. */ - total_code_acceptances?: number; - /** @description The number of lines of code suggested by Copilot code completions for the given editor, for the given language. */ - total_code_lines_suggested?: number; - /** @description The number of lines of code accepted from Copilot code suggestions for the given editor, for the given language. */ - total_code_lines_accepted?: number; - }[]; - }[]; - } & { - [key: string]: unknown; - })[]; - } & { - [key: string]: unknown; - }) | null; - /** @description Usage metrics for Copilot Chat in the IDE. */ - "copilot-ide-chat": ({ - /** @description Total number of users who prompted Copilot Chat in the IDE. */ - total_engaged_users?: number; - editors?: { - /** @description Name of the given editor. */ - name?: string; - /** @description The number of users who prompted Copilot Chat in the specified editor. */ - total_engaged_users?: number; - /** @description List of model metrics for custom models and the default model. */ - models?: { - /** @description Name of the language used for Copilot code completion suggestions, for the given editor. */ - name?: string; - /** @description Indicates whether a model is custom or default. */ - is_custom_model?: boolean; - /** @description The training date for the custom model. */ - custom_model_training_date?: string | null; - /** @description The number of users who prompted Copilot Chat in the given editor and model. */ - total_engaged_users?: number; - /** @description The total number of chats initiated by users in the given editor and model. */ - total_chats?: number; - /** @description The number of times users accepted a code suggestion from Copilot Chat using the 'Insert Code' UI element, for the given editor. */ - total_chat_insertion_events?: number; - /** @description The number of times users copied a code suggestion from Copilot Chat using the keyboard, or the 'Copy' UI element, for the given editor. */ - total_chat_copy_events?: number; - }[]; - }[]; - } & { - [key: string]: unknown; - }) | null; - /** @description Usage metrics for Copilot Chat in github.com */ - "copilot-dotcom-chat": ({ - /** @description Total number of users who prompted Copilot Chat on github.com at least once. */ - total_engaged_users?: number; - /** @description List of model metrics for a custom models and the default model. */ - models?: { - /** @description Name of the language used for Copilot code completion suggestions, for the given editor. */ - name?: string; - /** @description Indicates whether a model is custom or default. */ - is_custom_model?: boolean; - /** @description The training date for the custom model (if applicable). */ - custom_model_training_date?: string | null; - /** @description Total number of users who prompted Copilot Chat on github.com at least once for each model. */ - total_engaged_users?: number; - /** @description Total number of chats initiated by users on github.com. */ - total_chats?: number; - }[]; - } & { - [key: string]: unknown; - }) | null; - /** @description Usage metrics for Copilot for pull requests. */ - "copilot-dotcom-pull-requests": ({ - /** @description The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once. */ - total_engaged_users?: number; - /** @description Repositories in which users used Copilot for Pull Requests to generate pull request summaries */ - repositories?: { - /** @description Repository name */ - name?: string; - /** @description The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository. */ - total_engaged_users?: number; - /** @description List of model metrics for custom models and the default model. */ - models?: { - /** @description Name of the language used for Copilot code completion suggestions, for the given editor. */ - name?: string; - /** @description Indicates whether a model is custom or default. */ - is_custom_model?: boolean; - /** @description The training date for the custom model. */ - custom_model_training_date?: string | null; - /** @description The number of pull request summaries generated using Copilot for Pull Requests in the given repository. */ - total_pr_summaries_created?: number; - /** @description The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository and model. */ - total_engaged_users?: number; - }[]; - }[]; - } & { - [key: string]: unknown; - }) | null; - /** - * Copilot Usage Metrics - * @description Copilot usage metrics for a given day. - */ - "copilot-usage-metrics-day": { - /** - * Format: date - * @description The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format. - */ - date: string; - /** @description The total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint. */ - total_active_users?: number; - /** @description The total number of Copilot users who engaged with any Copilot feature, for the given day. Examples include but are not limited to accepting a code suggestion, prompting Copilot chat, or triggering a PR Summary. Does not include authentication events. Is not limited to the individual features detailed on the endpoint. */ - total_engaged_users?: number; - copilot_ide_code_completions?: components["schemas"]["copilot-ide-code-completions"]; - copilot_ide_chat?: components["schemas"]["copilot-ide-chat"]; - copilot_dotcom_chat?: components["schemas"]["copilot-dotcom-chat"]; - copilot_dotcom_pull_requests?: components["schemas"]["copilot-dotcom-pull-requests"]; - } & { - [key: string]: unknown; - }; - /** - * Copilot Usage Metrics - * @description Summary of Copilot usage. - */ - "copilot-usage-metrics": { + /** @description Feature options for code scanning default setup */ + "code-scanning-default-setup-options": { /** - * Format: date - * @description The date for which the usage metrics are reported, in `YYYY-MM-DD` format. - */ - day: string; - /** @description The total number of Copilot code completion suggestions shown to users. */ - total_suggestions_count?: number; - /** @description The total number of Copilot code completion suggestions accepted by users. */ - total_acceptances_count?: number; - /** @description The total number of lines of code completions suggested by Copilot. */ - total_lines_suggested?: number; - /** @description The total number of lines of code completions accepted by users. */ - total_lines_accepted?: number; - /** @description The total number of users who were shown Copilot code completion suggestions during the day specified. */ - total_active_users?: number; - /** @description The total instances of users who accepted code suggested by Copilot Chat in the IDE (panel and inline). */ - total_chat_acceptances?: number; - /** @description The total number of chat turns (prompt and response pairs) sent between users and Copilot Chat in the IDE. */ - total_chat_turns?: number; - /** @description The total number of users who interacted with Copilot Chat in the IDE during the day specified. */ - total_active_chat_users?: number; - /** @description Breakdown of Copilot code completions usage by language and editor */ - breakdown: ({ - /** @description The language in which Copilot suggestions were shown to users in the specified editor. */ - language?: string; - /** @description The editor in which Copilot suggestions were shown to users for the specified language. */ - editor?: string; - /** @description The number of Copilot suggestions shown to users in the editor specified during the day specified. */ - suggestions_count?: number; - /** @description The number of Copilot suggestions accepted by users in the editor specified during the day specified. */ - acceptances_count?: number; - /** @description The number of lines of code suggested by Copilot in the editor specified during the day specified. */ - lines_suggested?: number; - /** @description The number of lines of code accepted by users in the editor specified during the day specified. */ - lines_accepted?: number; - /** @description The number of users who were shown Copilot completion suggestions in the editor specified during the day specified. */ - active_users?: number; - } & { - [key: string]: unknown; - })[] | null; - }; - /** @description The security alert number. */ - "alert-number": number; - /** @description Details for the vulnerable package. */ - "dependabot-alert-package": { - /** @description The package's language or package management ecosystem. */ - readonly ecosystem: string; - /** @description The unique package name within its ecosystem. */ - readonly name: string; - }; - /** @description Details pertaining to one vulnerable version range for the advisory. */ - "dependabot-alert-security-vulnerability": { - package: components["schemas"]["dependabot-alert-package"]; - /** - * @description The severity of the vulnerability. + * @description Whether to use labeled runners or standard GitHub runners. * @enum {string} */ - readonly severity: "low" | "medium" | "high" | "critical"; - /** @description Conditions that identify vulnerable versions of this vulnerability's package. */ - readonly vulnerable_version_range: string; - /** @description Details pertaining to the package version that patches this vulnerability. */ - readonly first_patched_version: { - /** @description The package version that patches this vulnerability. */ - readonly identifier: string; - } | null; - }; - /** @description Details for the GitHub Security Advisory. */ - "dependabot-alert-security-advisory": { - /** @description The unique GitHub Security Advisory ID assigned to the advisory. */ - readonly ghsa_id: string; - /** @description The unique CVE ID assigned to the advisory. */ - readonly cve_id: string | null; - /** @description A short, plain text summary of the advisory. */ - readonly summary: string; - /** @description A long-form Markdown-supported description of the advisory. */ - readonly description: string; - /** @description Vulnerable version range information for the advisory. */ - readonly vulnerabilities: components["schemas"]["dependabot-alert-security-vulnerability"][]; - /** - * @description The severity of the advisory. - * @enum {string} - */ - readonly severity: "low" | "medium" | "high" | "critical"; - /** @description Details for the advisory pertaining to the Common Vulnerability Scoring System. */ - readonly cvss: { - /** @description The overall CVSS score of the advisory. */ - readonly score: number; - /** @description The full CVSS vector string for the advisory. */ - readonly vector_string: string | null; - }; - cvss_severities?: components["schemas"]["cvss-severities"]; - /** @description Details for the advisory pertaining to Common Weakness Enumeration. */ - readonly cwes: { - /** @description The unique CWE ID. */ - readonly cwe_id: string; - /** @description The short, plain text name of the CWE. */ - readonly name: string; - }[]; - /** @description Values that identify this advisory among security information sources. */ - readonly identifiers: { - /** - * @description The type of advisory identifier. - * @enum {string} - */ - readonly type: "CVE" | "GHSA"; - /** @description The value of the advisory identifer. */ - readonly value: string; - }[]; - /** @description Links to additional advisory information. */ - readonly references: { - /** - * Format: uri - * @description The URL of the reference. - */ - readonly url: string; - }[]; - /** - * Format: date-time - * @description The time that the advisory was published in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. - */ - readonly published_at: string; - /** - * Format: date-time - * @description The time that the advisory was last modified in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. - */ - readonly updated_at: string; + runner_type?: "standard" | "labeled" | "not_set"; + /** @description The label of the runner to use for code scanning default setup when runner_type is 'labeled'. */ + runner_label?: string | null; + } | null; + /** @description A list of default code security configurations */ + "code-security-default-configurations": { /** - * Format: date-time - * @description The time that the advisory was withdrawn in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @description The visibility of newly created repositories for which the code security configuration will be applied to by default + * @enum {unknown} */ - readonly withdrawn_at: string | null; - }; - /** - * Format: uri - * @description The REST API URL of the alert resource. - */ - "alert-url": string; - /** - * Format: uri - * @description The GitHub URL of the alert resource. - */ - "alert-html-url": string; - /** - * Format: date-time - * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. - */ - "alert-created-at": string; - /** - * Format: date-time - * @description The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. - */ - "alert-updated-at": string; - /** - * Format: date-time - * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. - */ - "alert-dismissed-at": string | null; - /** - * Format: date-time - * @description The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. - */ - "alert-fixed-at": string | null; - /** - * Format: date-time - * @description The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. - */ - "alert-auto-dismissed-at": string | null; + default_for_new_repos?: "public" | "private_and_internal" | "all"; + configuration?: components["schemas"]["code-security-configuration"]; + }[]; /** * Simple Repository * @description A GitHub repository. @@ -20549,6 +20481,141 @@ export interface components { */ hooks_url: string; }; + /** @description Repositories associated with a code security configuration and attachment status */ + "code-security-configuration-repositories": { + /** + * @description The attachment status of the code security configuration on the repository. + * @enum {string} + */ + status?: "attached" | "attaching" | "detached" | "removed" | "enforced" | "failed" | "updating" | "removed_by_enterprise"; + repository?: components["schemas"]["simple-repository"]; + }; + /** @description The security alert number. */ + "alert-number": number; + /** @description Details for the vulnerable package. */ + "dependabot-alert-package": { + /** @description The package's language or package management ecosystem. */ + readonly ecosystem: string; + /** @description The unique package name within its ecosystem. */ + readonly name: string; + }; + /** @description Details pertaining to one vulnerable version range for the advisory. */ + "dependabot-alert-security-vulnerability": { + package: components["schemas"]["dependabot-alert-package"]; + /** + * @description The severity of the vulnerability. + * @enum {string} + */ + readonly severity: "low" | "medium" | "high" | "critical"; + /** @description Conditions that identify vulnerable versions of this vulnerability's package. */ + readonly vulnerable_version_range: string; + /** @description Details pertaining to the package version that patches this vulnerability. */ + readonly first_patched_version: { + /** @description The package version that patches this vulnerability. */ + readonly identifier: string; + } | null; + }; + /** @description Details for the GitHub Security Advisory. */ + "dependabot-alert-security-advisory": { + /** @description The unique GitHub Security Advisory ID assigned to the advisory. */ + readonly ghsa_id: string; + /** @description The unique CVE ID assigned to the advisory. */ + readonly cve_id: string | null; + /** @description A short, plain text summary of the advisory. */ + readonly summary: string; + /** @description A long-form Markdown-supported description of the advisory. */ + readonly description: string; + /** @description Vulnerable version range information for the advisory. */ + readonly vulnerabilities: components["schemas"]["dependabot-alert-security-vulnerability"][]; + /** + * @description The severity of the advisory. + * @enum {string} + */ + readonly severity: "low" | "medium" | "high" | "critical"; + /** @description Details for the advisory pertaining to the Common Vulnerability Scoring System. */ + readonly cvss: { + /** @description The overall CVSS score of the advisory. */ + readonly score: number; + /** @description The full CVSS vector string for the advisory. */ + readonly vector_string: string | null; + }; + cvss_severities?: components["schemas"]["cvss-severities"]; + /** @description Details for the advisory pertaining to Common Weakness Enumeration. */ + readonly cwes: { + /** @description The unique CWE ID. */ + readonly cwe_id: string; + /** @description The short, plain text name of the CWE. */ + readonly name: string; + }[]; + /** @description Values that identify this advisory among security information sources. */ + readonly identifiers: { + /** + * @description The type of advisory identifier. + * @enum {string} + */ + readonly type: "CVE" | "GHSA"; + /** @description The value of the advisory identifer. */ + readonly value: string; + }[]; + /** @description Links to additional advisory information. */ + readonly references: { + /** + * Format: uri + * @description The URL of the reference. + */ + readonly url: string; + }[]; + /** + * Format: date-time + * @description The time that the advisory was published in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + readonly published_at: string; + /** + * Format: date-time + * @description The time that the advisory was last modified in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + readonly updated_at: string; + /** + * Format: date-time + * @description The time that the advisory was withdrawn in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + readonly withdrawn_at: string | null; + }; + /** + * Format: uri + * @description The REST API URL of the alert resource. + */ + "alert-url": string; + /** + * Format: uri + * @description The GitHub URL of the alert resource. + */ + "alert-html-url": string; + /** + * Format: date-time + * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + "alert-created-at": string; + /** + * Format: date-time + * @description The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + "alert-updated-at": string; + /** + * Format: date-time + * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + "alert-dismissed-at": string | null; + /** + * Format: date-time + * @description The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + "alert-fixed-at": string | null; + /** + * Format: date-time + * @description The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + "alert-auto-dismissed-at": string | null; /** @description A Dependabot alert. */ "dependabot-alert-with-repository": { number: components["schemas"]["alert-number"]; @@ -20637,6 +20704,16 @@ export interface components { * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ push_protection_bypassed_at?: string | null; + push_protection_bypass_request_reviewer?: components["schemas"]["nullable-simple-user"]; + /** @description An optional comment when reviewing a push protection bypass. */ + push_protection_bypass_request_reviewer_comment?: string | null; + /** @description An optional comment when requesting a push protection bypass. */ + push_protection_bypass_request_comment?: string | null; + /** + * Format: uri + * @description The URL to a push protection bypass request. + */ + push_protection_bypass_request_html_url?: string | null; /** @description The comment that was optionally added when this alert was closed */ resolution_comment?: string | null; /** @@ -20836,6 +20913,12 @@ export interface components { eyes: number; rocket: number; }; + /** Sub-issues Summary */ + "sub-issues-summary": { + total: number; + completed: number; + percent_completed: number; + }; /** * Issue * @description Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. @@ -20938,6 +21021,7 @@ export interface components { performed_via_github_app?: components["schemas"]["nullable-integration"]; author_association: components["schemas"]["author-association"]; reactions?: components["schemas"]["reaction-rollup"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; }; /** * Issue Comment @@ -21624,6 +21708,10 @@ export interface components { copilot?: string[]; packages?: string[]; actions?: string[]; + actions_inbound?: { + full_domains?: string[]; + wildcard_domains?: string[]; + }; artifact_attestations?: { /** @example [ * "example" @@ -21967,6 +22055,32 @@ export interface components { /** @example A great organization */ description: string | null; }; + "billing-usage-report": { + usageItems?: { + /** @description Date of the usage line item. */ + date: string; + /** @description Product name. */ + product: string; + /** @description SKU name. */ + sku: string; + /** @description Quantity of the usage line item. */ + quantity: number; + /** @description Unit type of the usage line item. */ + unitType: string; + /** @description Price per unit of the usage line item. */ + pricePerUnit: number; + /** @description Gross amount of the usage line item. */ + grossAmount: number; + /** @description Discount amount of the usage line item. */ + discountAmount: number; + /** @description Net amount of the usage line item. */ + netAmount: number; + /** @description Name of the organization. */ + organizationName: string; + /** @description Name of the repository. */ + repositoryName?: string; + }[]; + }; /** * Organization Full * @description Organization Full @@ -22588,135 +22702,6 @@ export interface components { most_recent_instance: components["schemas"]["code-scanning-alert-instance"]; repository: components["schemas"]["simple-repository"]; }; - /** @description A code security configuration */ - "code-security-configuration": { - /** @description The ID of the code security configuration */ - id?: number; - /** @description The name of the code security configuration. Must be unique within the organization. */ - name?: string; - /** - * @description The type of the code security configuration. - * @enum {string} - */ - target_type?: "global" | "organization" | "enterprise"; - /** @description A description of the code security configuration */ - description?: string; - /** - * @description The enablement status of GitHub Advanced Security - * @enum {string} - */ - advanced_security?: "enabled" | "disabled"; - /** - * @description The enablement status of Dependency Graph - * @enum {string} - */ - dependency_graph?: "enabled" | "disabled" | "not_set"; - /** - * @description The enablement status of Automatic dependency submission - * @enum {string} - */ - dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"; - /** @description Feature options for Automatic dependency submission */ - dependency_graph_autosubmit_action_options?: { - /** @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. */ - labeled_runners?: boolean; - }; - /** - * @description The enablement status of Dependabot alerts - * @enum {string} - */ - dependabot_alerts?: "enabled" | "disabled" | "not_set"; - /** - * @description The enablement status of Dependabot security updates - * @enum {string} - */ - dependabot_security_updates?: "enabled" | "disabled" | "not_set"; - /** - * @description The enablement status of code scanning default setup - * @enum {string} - */ - code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; - /** - * @description The enablement status of secret scanning - * @enum {string} - */ - secret_scanning?: "enabled" | "disabled" | "not_set"; - /** - * @description The enablement status of secret scanning push protection - * @enum {string} - */ - secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; - /** - * @description The enablement status of secret scanning delegated bypass - * @enum {string} - */ - secret_scanning_delegated_bypass?: "enabled" | "disabled" | "not_set"; - /** @description Feature options for secret scanning delegated bypass */ - secret_scanning_delegated_bypass_options?: { - /** @description The bypass reviewers for secret scanning delegated bypass */ - reviewers?: { - /** @description The ID of the team or role selected as a bypass reviewer */ - reviewer_id: number; - /** - * @description The type of the bypass reviewer - * @enum {string} - */ - reviewer_type: "TEAM" | "ROLE"; - }[]; - }; - /** - * @description The enablement status of secret scanning validity checks - * @enum {string} - */ - secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; - /** - * @description The enablement status of secret scanning non-provider patterns - * @enum {string} - */ - secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set"; - /** - * @description The enablement status of private vulnerability reporting - * @enum {string} - */ - private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; - /** - * @description The enforcement status for a security configuration - * @enum {string} - */ - enforcement?: "enforced" | "unenforced"; - /** - * Format: uri - * @description The URL of the configuration - */ - url?: string; - /** - * Format: uri - * @description The URL of the configuration - */ - html_url?: string; - /** Format: date-time */ - created_at?: string; - /** Format: date-time */ - updated_at?: string; - }; - /** @description A list of default code security configurations */ - "code-security-default-configurations": { - /** - * @description The visibility of newly created repositories for which the code security configuration will be applied to by default - * @enum {unknown} - */ - default_for_new_repos?: "public" | "private_and_internal" | "all"; - configuration?: components["schemas"]["code-security-configuration"]; - }[]; - /** @description Repositories associated with a code security configuration and attachment status */ - "code-security-configuration-repositories": { - /** - * @description The attachment status of the code security configuration on the repository. - * @enum {string} - */ - status?: "attached" | "attaching" | "detached" | "removed" | "enforced" | "failed" | "updating" | "removed_by_enterprise"; - repository?: components["schemas"]["simple-repository"]; - }; /** * Codespace machine * @description A description of the machine powering a codespace. @@ -22973,62 +22958,452 @@ export interface components { created_at?: string; }; /** - * Copilot Business Seat Breakdown - * @description The breakdown of Copilot Business seats for the organization. + * Copilot Business Seat Breakdown + * @description The breakdown of Copilot Business seats for the organization. + */ + "copilot-seat-breakdown": { + /** @description The total number of seats being billed for the organization as of the current billing cycle. */ + total?: number; + /** @description Seats added during the current billing cycle. */ + added_this_cycle?: number; + /** @description The number of seats that are pending cancellation at the end of the current billing cycle. */ + pending_cancellation?: number; + /** @description The number of seats that have been assigned to users that have not yet accepted an invitation to this organization. */ + pending_invitation?: number; + /** @description The number of seats that have used Copilot during the current billing cycle. */ + active_this_cycle?: number; + /** @description The number of seats that have not used Copilot during the current billing cycle. */ + inactive_this_cycle?: number; + }; + /** + * Copilot Organization Details + * @description Information about the seat breakdown and policies set for an organization with a Copilot Business or Copilot Enterprise subscription. + */ + "copilot-organization-details": { + seat_breakdown: components["schemas"]["copilot-seat-breakdown"]; + /** + * @description The organization policy for allowing or disallowing Copilot to make suggestions that match public code. + * @enum {string} + */ + public_code_suggestions: "allow" | "block" | "unconfigured" | "unknown"; + /** + * @description The organization policy for allowing or disallowing organization members to use Copilot Chat within their editor. + * @enum {string} + */ + ide_chat?: "enabled" | "disabled" | "unconfigured"; + /** + * @description The organization policy for allowing or disallowing organization members to use Copilot features within github.com. + * @enum {string} + */ + platform_chat?: "enabled" | "disabled" | "unconfigured"; + /** + * @description The organization policy for allowing or disallowing organization members to use Copilot within their CLI. + * @enum {string} + */ + cli?: "enabled" | "disabled" | "unconfigured"; + /** + * @description The mode of assigning new seats. + * @enum {string} + */ + seat_management_setting: "assign_all" | "assign_selected" | "disabled" | "unconfigured"; + /** + * @description The Copilot plan of the organization, or the parent enterprise, when applicable. + * @enum {string} + */ + plan_type?: "business" | "enterprise" | "unknown"; + } & { + [key: string]: unknown; + }; + /** + * Organization Simple + * @description A GitHub organization. + */ + "nullable-organization-simple": { + /** @example github */ + login: string; + /** @example 1 */ + id: number; + /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ + node_id: string; + /** + * Format: uri + * @example https://api.github.com/orgs/github + */ + url: string; + /** + * Format: uri + * @example https://api.github.com/orgs/github/repos + */ + repos_url: string; + /** + * Format: uri + * @example https://api.github.com/orgs/github/events + */ + events_url: string; + /** @example https://api.github.com/orgs/github/hooks */ + hooks_url: string; + /** @example https://api.github.com/orgs/github/issues */ + issues_url: string; + /** @example https://api.github.com/orgs/github/members{/member} */ + members_url: string; + /** @example https://api.github.com/orgs/github/public_members{/member} */ + public_members_url: string; + /** @example https://github.com/images/error/octocat_happy.gif */ + avatar_url: string; + /** @example A great organization */ + description: string | null; + } | null; + /** + * Team Simple + * @description Groups of organization members that gives permissions on specified repositories. + */ + "nullable-team-simple": { + /** + * @description Unique identifier of the team + * @example 1 + */ + id: number; + /** @example MDQ6VGVhbTE= */ + node_id: string; + /** + * Format: uri + * @description URL for the team + * @example https://api.github.com/organizations/1/team/1 + */ + url: string; + /** @example https://api.github.com/organizations/1/team/1/members{/member} */ + members_url: string; + /** + * @description Name of the team + * @example Justice League + */ + name: string; + /** + * @description Description of the team + * @example A great team. + */ + description: string | null; + /** + * @description Permission that the team will have for its repositories + * @example admin + */ + permission: string; + /** + * @description The level of privacy this team should have + * @example closed + */ + privacy?: string; + /** + * @description The notification setting the team has set + * @example notifications_enabled + */ + notification_setting?: string; + /** + * Format: uri + * @example https://github.com/orgs/rails/teams/core + */ + html_url: string; + /** + * Format: uri + * @example https://api.github.com/organizations/1/team/1/repos + */ + repositories_url: string; + /** @example justice-league */ + slug: string; + /** + * @description Distinguished Name (DN) that team maps to within LDAP environment + * @example uid=example,ou=users,dc=github,dc=com + */ + ldap_dn?: string; + } | null; + /** + * Team + * @description Groups of organization members that gives permissions on specified repositories. + */ + team: { + id: number; + node_id: string; + name: string; + slug: string; + description: string | null; + privacy?: string; + notification_setting?: string; + permission: string; + permissions?: { + pull: boolean; + triage: boolean; + push: boolean; + maintain: boolean; + admin: boolean; + }; + /** Format: uri */ + url: string; + /** + * Format: uri + * @example https://github.com/orgs/rails/teams/core + */ + html_url: string; + members_url: string; + /** Format: uri */ + repositories_url: string; + parent: components["schemas"]["nullable-team-simple"]; + }; + /** + * Enterprise Team + * @description Group of enterprise owners and/or members */ - "copilot-seat-breakdown": { - /** @description The total number of seats being billed for the organization as of the current billing cycle. */ - total?: number; - /** @description Seats added during the current billing cycle. */ - added_this_cycle?: number; - /** @description The number of seats that are pending cancellation at the end of the current billing cycle. */ - pending_cancellation?: number; - /** @description The number of seats that have been assigned to users that have not yet accepted an invitation to this organization. */ - pending_invitation?: number; - /** @description The number of seats that have used Copilot during the current billing cycle. */ - active_this_cycle?: number; - /** @description The number of seats that have not used Copilot during the current billing cycle. */ - inactive_this_cycle?: number; + "enterprise-team": { + /** Format: int64 */ + id: number; + name: string; + slug: string; + /** Format: uri */ + url: string; + /** @example disabled | all */ + sync_to_organizations: string; + /** @example 62ab9291-fae2-468e-974b-7e45096d5021 */ + group_id?: string | null; + /** + * Format: uri + * @example https://github.com/enterprises/dc/teams/justice-league + */ + html_url: string; + members_url: string; + /** Format: date-time */ + created_at: string; + /** Format: date-time */ + updated_at: string; }; /** - * Copilot Organization Details - * @description Information about the seat breakdown and policies set for an organization with a Copilot Business or Copilot Enterprise subscription. + * Copilot Business Seat Detail + * @description Information about a Copilot Business seat assignment for a user, team, or organization. */ - "copilot-organization-details": { - seat_breakdown: components["schemas"]["copilot-seat-breakdown"]; - /** - * @description The organization policy for allowing or disallowing Copilot to make suggestions that match public code. - * @enum {string} - */ - public_code_suggestions: "allow" | "block" | "unconfigured" | "unknown"; + "copilot-seat-details": { + assignee: components["schemas"]["simple-user"]; + organization?: components["schemas"]["nullable-organization-simple"]; + /** @description The team through which the assignee is granted access to GitHub Copilot, if applicable. */ + assigning_team?: (components["schemas"]["team"] | components["schemas"]["enterprise-team"]) | null; /** - * @description The organization policy for allowing or disallowing organization members to use Copilot Chat within their editor. - * @enum {string} + * Format: date + * @description The pending cancellation date for the seat, in `YYYY-MM-DD` format. This will be null unless the assignee's Copilot access has been canceled during the current billing cycle. If the seat has been cancelled, this corresponds to the start of the organization's next billing cycle. */ - ide_chat?: "enabled" | "disabled" | "unconfigured"; + pending_cancellation_date?: string | null; /** - * @description The organization policy for allowing or disallowing organization members to use Copilot features within github.com. - * @enum {string} + * Format: date-time + * @description Timestamp of user's last GitHub Copilot activity, in ISO 8601 format. */ - platform_chat?: "enabled" | "disabled" | "unconfigured"; + last_activity_at?: string | null; + /** @description Last editor that was used by the user for a GitHub Copilot completion. */ + last_activity_editor?: string | null; /** - * @description The organization policy for allowing or disallowing organization members to use Copilot within their CLI. - * @enum {string} + * Format: date-time + * @description Timestamp of when the assignee was last granted access to GitHub Copilot, in ISO 8601 format. */ - cli?: "enabled" | "disabled" | "unconfigured"; + created_at: string; /** - * @description The mode of assigning new seats. - * @enum {string} + * Format: date-time + * @deprecated + * @description **Closing down notice:** This field is no longer relevant and is closing down. Use the `created_at` field to determine when the assignee was last granted access to GitHub Copilot. Timestamp of when the assignee's GitHub Copilot access was last updated, in ISO 8601 format. */ - seat_management_setting: "assign_all" | "assign_selected" | "disabled" | "unconfigured"; + updated_at?: string; /** * @description The Copilot plan of the organization, or the parent enterprise, when applicable. * @enum {string} */ plan_type?: "business" | "enterprise" | "unknown"; + }; + /** @description Usage metrics for Copilot editor code completions in the IDE. */ + "copilot-ide-code-completions": ({ + /** @description Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances. */ + total_engaged_users?: number; + /** @description Code completion metrics for active languages. */ + languages?: { + /** @description Name of the language used for Copilot code completion suggestions. */ + name?: string; + /** @description Number of users who accepted at least one Copilot code completion suggestion for the given language. Includes both full and partial acceptances. */ + total_engaged_users?: number; + }[]; + editors?: ({ + /** @description Name of the given editor. */ + name?: string; + /** @description Number of users who accepted at least one Copilot code completion suggestion for the given editor. Includes both full and partial acceptances. */ + total_engaged_users?: number; + /** @description List of model metrics for custom models and the default model. */ + models?: { + /** @description Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'. */ + name?: string; + /** @description Indicates whether a model is custom or default. */ + is_custom_model?: boolean; + /** @description The training date for the custom model. */ + custom_model_training_date?: string | null; + /** @description Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances. */ + total_engaged_users?: number; + /** @description Code completion metrics for active languages, for the given editor. */ + languages?: { + /** @description Name of the language used for Copilot code completion suggestions, for the given editor. */ + name?: string; + /** @description Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language. Includes both full and partial acceptances. */ + total_engaged_users?: number; + /** @description The number of Copilot code suggestions generated for the given editor, for the given language. */ + total_code_suggestions?: number; + /** @description The number of Copilot code suggestions accepted for the given editor, for the given language. Includes both full and partial acceptances. */ + total_code_acceptances?: number; + /** @description The number of lines of code suggested by Copilot code completions for the given editor, for the given language. */ + total_code_lines_suggested?: number; + /** @description The number of lines of code accepted from Copilot code suggestions for the given editor, for the given language. */ + total_code_lines_accepted?: number; + }[]; + }[]; + } & { + [key: string]: unknown; + })[]; + } & { + [key: string]: unknown; + }) | null; + /** @description Usage metrics for Copilot Chat in the IDE. */ + "copilot-ide-chat": ({ + /** @description Total number of users who prompted Copilot Chat in the IDE. */ + total_engaged_users?: number; + editors?: { + /** @description Name of the given editor. */ + name?: string; + /** @description The number of users who prompted Copilot Chat in the specified editor. */ + total_engaged_users?: number; + /** @description List of model metrics for custom models and the default model. */ + models?: { + /** @description Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'. */ + name?: string; + /** @description Indicates whether a model is custom or default. */ + is_custom_model?: boolean; + /** @description The training date for the custom model. */ + custom_model_training_date?: string | null; + /** @description The number of users who prompted Copilot Chat in the given editor and model. */ + total_engaged_users?: number; + /** @description The total number of chats initiated by users in the given editor and model. */ + total_chats?: number; + /** @description The number of times users accepted a code suggestion from Copilot Chat using the 'Insert Code' UI element, for the given editor. */ + total_chat_insertion_events?: number; + /** @description The number of times users copied a code suggestion from Copilot Chat using the keyboard, or the 'Copy' UI element, for the given editor. */ + total_chat_copy_events?: number; + }[]; + }[]; + } & { + [key: string]: unknown; + }) | null; + /** @description Usage metrics for Copilot Chat in github.com */ + "copilot-dotcom-chat": ({ + /** @description Total number of users who prompted Copilot Chat on github.com at least once. */ + total_engaged_users?: number; + /** @description List of model metrics for a custom models and the default model. */ + models?: { + /** @description Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'. */ + name?: string; + /** @description Indicates whether a model is custom or default. */ + is_custom_model?: boolean; + /** @description The training date for the custom model (if applicable). */ + custom_model_training_date?: string | null; + /** @description Total number of users who prompted Copilot Chat on github.com at least once for each model. */ + total_engaged_users?: number; + /** @description Total number of chats initiated by users on github.com. */ + total_chats?: number; + }[]; + } & { + [key: string]: unknown; + }) | null; + /** @description Usage metrics for Copilot for pull requests. */ + "copilot-dotcom-pull-requests": ({ + /** @description The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once. */ + total_engaged_users?: number; + /** @description Repositories in which users used Copilot for Pull Requests to generate pull request summaries */ + repositories?: { + /** @description Repository name */ + name?: string; + /** @description The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository. */ + total_engaged_users?: number; + /** @description List of model metrics for custom models and the default model. */ + models?: { + /** @description Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'. */ + name?: string; + /** @description Indicates whether a model is custom or default. */ + is_custom_model?: boolean; + /** @description The training date for the custom model. */ + custom_model_training_date?: string | null; + /** @description The number of pull request summaries generated using Copilot for Pull Requests in the given repository. */ + total_pr_summaries_created?: number; + /** @description The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository and model. */ + total_engaged_users?: number; + }[]; + }[]; + } & { + [key: string]: unknown; + }) | null; + /** + * Copilot Usage Metrics + * @description Copilot usage metrics for a given day. + */ + "copilot-usage-metrics-day": { + /** + * Format: date + * @description The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format. + */ + date: string; + /** @description The total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint. */ + total_active_users?: number; + /** @description The total number of Copilot users who engaged with any Copilot feature, for the given day. Examples include but are not limited to accepting a code suggestion, prompting Copilot chat, or triggering a PR Summary. Does not include authentication events. Is not limited to the individual features detailed on the endpoint. */ + total_engaged_users?: number; + copilot_ide_code_completions?: components["schemas"]["copilot-ide-code-completions"]; + copilot_ide_chat?: components["schemas"]["copilot-ide-chat"]; + copilot_dotcom_chat?: components["schemas"]["copilot-dotcom-chat"]; + copilot_dotcom_pull_requests?: components["schemas"]["copilot-dotcom-pull-requests"]; } & { [key: string]: unknown; }; + /** + * Copilot Usage Metrics + * @description Summary of Copilot usage. + */ + "copilot-usage-metrics": { + /** + * Format: date + * @description The date for which the usage metrics are reported, in `YYYY-MM-DD` format. + */ + day: string; + /** @description The total number of Copilot code completion suggestions shown to users. */ + total_suggestions_count?: number; + /** @description The total number of Copilot code completion suggestions accepted by users. */ + total_acceptances_count?: number; + /** @description The total number of lines of code completions suggested by Copilot. */ + total_lines_suggested?: number; + /** @description The total number of lines of code completions accepted by users. */ + total_lines_accepted?: number; + /** @description The total number of users who were shown Copilot code completion suggestions during the day specified. */ + total_active_users?: number; + /** @description The total instances of users who accepted code suggested by Copilot Chat in the IDE (panel and inline). */ + total_chat_acceptances?: number; + /** @description The total number of chat turns (prompt and response pairs) sent between users and Copilot Chat in the IDE. */ + total_chat_turns?: number; + /** @description The total number of users who interacted with Copilot Chat in the IDE during the day specified. */ + total_active_chat_users?: number; + /** @description Breakdown of Copilot code completions usage by language and editor */ + breakdown: ({ + /** @description The language in which Copilot suggestions were shown to users in the specified editor. */ + language?: string; + /** @description The editor in which Copilot suggestions were shown to users for the specified language. */ + editor?: string; + /** @description The number of Copilot suggestions shown to users in the editor specified during the day specified. */ + suggestions_count?: number; + /** @description The number of Copilot suggestions accepted by users in the editor specified during the day specified. */ + acceptances_count?: number; + /** @description The number of lines of code suggested by Copilot in the editor specified during the day specified. */ + lines_suggested?: number; + /** @description The number of lines of code accepted by users in the editor specified during the day specified. */ + lines_accepted?: number; + /** @description The number of users who were shown Copilot completion suggestions in the editor specified during the day specified. */ + active_users?: number; + } & { + [key: string]: unknown; + })[] | null; + }; /** * Dependabot Secret for an Organization * @description Secrets for GitHub Dependabot for an organization. @@ -23608,6 +23983,16 @@ export interface components { name: string; /** @description A short description about who this role is for or what permissions it grants. */ description?: string | null; + /** + * @description The system role from which this role inherits permissions. + * @enum {string|null} + */ + base_role?: "read" | "triage" | "write" | "maintain" | "admin" | null; + /** + * @description Source answers the question, "where did this role come from?" + * @enum {string|null} + */ + source?: "Organization" | "Enterprise" | "Predefined" | null; /** @description A list of permissions included in this role. */ permissions: string[]; organization: components["schemas"]["nullable-simple-user"]; @@ -23627,6 +24012,12 @@ export interface components { * @description The Relationship a Team has with a role. */ "team-role-assignment": { + /** + * @description Determines if the team has a direct, indirect, or mixed relationship to a role + * @example direct + * @enum {string} + */ + assignment?: "direct" | "indirect" | "mixed"; id: number; node_id: string; name: string; @@ -23722,6 +24113,14 @@ export interface components { * @description The Relationship a User has with a role. */ "user-role-assignment": { + /** + * @description Determines if the user has a direct, indirect, or mixed relationship to a role + * @example direct + * @enum {string} + */ + assignment?: "direct" | "indirect" | "mixed"; + /** @description Team the user has gotten the role through */ + inherited_from?: components["schemas"]["team-simple"][]; name?: string | null; email?: string | null; /** @example octocat */ @@ -23926,6 +24325,68 @@ export interface components { /** @description Date and time when the associated fine-grained personal access token was last used for authentication. */ token_last_used_at: string | null; }; + /** + * Organization private registry + * @description Private registry configuration for an organization + */ + "org-private-registry-configuration": { + /** + * @description The name of the private registry configuration. + * @example MAVEN_REPOSITORY_SECRET + */ + name: string; + /** + * @description The registry type. + * @enum {string} + */ + registry_type: "maven_repository"; + /** + * @description The username to use when authenticating with the private registry. + * @example monalisa + */ + username?: string | null; + /** + * @description Which type of organization repositories have access to the private registry. + * @enum {string} + */ + visibility: "all" | "private" | "selected"; + /** Format: date-time */ + created_at: string; + /** Format: date-time */ + updated_at: string; + }; + /** + * Organization private registry + * @description Private registry configuration for an organization + */ + "org-private-registry-configuration-with-selected-repositories": { + /** + * @description The name of the private registry configuration. + * @example MAVEN_REPOSITORY_SECRET + */ + name: string; + /** + * @description The registry type. + * @enum {string} + */ + registry_type: "maven_repository"; + /** + * @description The username to use when authenticating with the private registry. + * @example monalisa + */ + username?: string; + /** + * @description Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry. + * @enum {string} + */ + visibility: "all" | "private" | "selected"; + /** @description An array of repository IDs that can access the organization private registry when `visibility` is set to `selected`. */ + selected_repository_ids?: number[]; + /** Format: date-time */ + created_at: string; + /** Format: date-time */ + updated_at: string; + }; /** * Project * @description Projects are a way to organize columns and cards of work. @@ -24003,6 +24464,12 @@ export interface components { * @description The URL that can be used to fetch, update, or delete info about this property via the API. */ url?: string; + /** + * @description The source type of the property + * @example organization + * @enum {string} + */ + source_type?: "organization" | "enterprise"; /** * @description The type of the value for the property * @example single_select @@ -24025,6 +24492,27 @@ export interface components { */ values_editable_by?: "org_actors" | "org_and_repo_actors" | null; }; + /** + * Custom Property Set Payload + * @description Custom property set payload + */ + "custom-property-set-payload": { + /** + * @description The type of the value for the property + * @example single_select + * @enum {string} + */ + value_type: "string" | "single_select" | "multi_select" | "true_false"; + /** @description Whether the property is required. */ + required?: boolean; + /** @description Default value of the property */ + default_value?: (string | string[]) | null; + /** @description Short description of the property */ + description?: string | null; + /** @description An ordered list of the allowed values of the property. + * The property can have up to 200 allowed values. */ + allowed_values?: string[] | null; + }; /** * Custom Property Value * @description Custom property name and associated value @@ -24829,6 +25317,7 @@ export interface components { * @description Conditions for an organization ruleset. * The branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties. * The push rulesets conditions object does not require the `ref_name` property. + * For repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`. */ "org-ruleset-conditions": (components["schemas"]["repository-ruleset-conditions"] & components["schemas"]["repository-ruleset-conditions-repository-name-target"]) | (components["schemas"]["repository-ruleset-conditions"] & components["schemas"]["repository-ruleset-conditions-repository-id-target"]) | (components["schemas"]["repository-ruleset-conditions"] & components["schemas"]["repository-ruleset-conditions-repository-property-target"]); /** @@ -24937,6 +25426,8 @@ export interface components { /** @enum {string} */ type: "pull_request"; parameters?: { + /** @description When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled. */ + allowed_merge_methods?: string[]; /** @description New, reviewable commits pushed will dismiss previous pull request review approvals. */ dismiss_stale_reviews_on_push: boolean; /** @description Require an approving review in pull requests that modify files that have a designated code owner. */ @@ -25202,12 +25693,12 @@ export interface components { * @description The target of the ruleset * @enum {string} */ - target?: "branch" | "tag" | "push"; + target?: "branch" | "tag" | "push" | "repository"; /** * @description The type of the source of the ruleset * @enum {string} */ - source_type?: "Repository" | "Organization"; + source_type?: "Repository" | "Organization" | "Enterprise"; /** @description The name of the source */ source: string; enforcement: components["schemas"]["repository-rule-enforcement"]; @@ -26361,6 +26852,7 @@ export interface components { actions_runner_registration?: components["schemas"]["rate-limit"]; scim?: components["schemas"]["rate-limit"]; dependency_snapshots?: components["schemas"]["rate-limit"]; + code_scanning_autofix?: components["schemas"]["rate-limit"]; }; rate: components["schemas"]["rate-limit"]; }; @@ -27498,6 +27990,7 @@ export interface components { reason: string; payload: string | null; signature: string | null; + verified_at?: string | null; }; /** * Diff Entry @@ -28069,6 +28562,36 @@ export interface components { * @enum {string} */ "code-scanning-alert-set-state": "open" | "dismissed"; + /** + * @description The status of an autofix. + * @enum {string} + */ + "code-scanning-autofix-status": "pending" | "error" | "success" | "outdated"; + /** @description The description of an autofix. */ + "code-scanning-autofix-description": string | null; + /** + * Format: date-time + * @description The start time of an autofix in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + "code-scanning-autofix-started-at": string; + "code-scanning-autofix": { + status: components["schemas"]["code-scanning-autofix-status"]; + description: components["schemas"]["code-scanning-autofix-description"]; + started_at: components["schemas"]["code-scanning-autofix-started-at"]; + }; + /** @description Commit an autofix for a code scanning alert */ + "code-scanning-autofix-commits": { + /** @description The Git reference of target branch for the commit. Branch needs to already exist. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ + target_ref?: string; + /** @description Commit message to be used. */ + message?: string; + } | null; + "code-scanning-autofix-commits-response": { + /** @description The Git reference of target branch for the commit. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ + target_ref?: string; + /** @description SHA of commit with autofix. */ + sha?: string; + }; /** * @description An identifier for the upload. * @example 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53 @@ -28298,7 +28821,7 @@ export interface components { */ state?: "configured" | "not-configured"; /** @description Languages to be analyzed. */ - languages?: ("c-cpp" | "csharp" | "go" | "java-kotlin" | "javascript-typescript" | "javascript" | "python" | "ruby" | "typescript" | "swift")[]; + languages?: ("actions" | "c-cpp" | "csharp" | "go" | "java-kotlin" | "javascript-typescript" | "javascript" | "python" | "ruby" | "typescript" | "swift")[]; /** * @description CodeQL query suite to be used. * @enum {string} @@ -28323,13 +28846,23 @@ export interface components { * @enum {string} */ state?: "configured" | "not-configured"; + /** + * @description Runner type to be used. + * @enum {string} + */ + runner_type?: "standard" | "labeled"; + /** + * @description Runner label to be used if the runner type is labeled. + * @example code-scanning + */ + runner_label?: string | null; /** * @description CodeQL query suite to be used. * @enum {string} */ query_suite?: "default" | "extended"; /** @description CodeQL languages to be analyzed. */ - languages?: ("c-cpp" | "csharp" | "go" | "java-kotlin" | "javascript-typescript" | "python" | "ruby" | "swift")[]; + languages?: ("actions" | "c-cpp" | "csharp" | "go" | "java-kotlin" | "javascript-typescript" | "python" | "ruby" | "swift")[]; }; /** @description You can use `run_url` to track the status of the run. This includes a property status and conclusion. * You should not rely on this always being an actions workflow run object. */ @@ -29285,6 +29818,7 @@ export interface components { reason?: string; signature?: string | null; payload?: string | null; + verified_at?: string | null; }; }; }; @@ -30039,6 +30573,7 @@ export interface components { reason: string; signature: string | null; payload: string | null; + verified_at?: string | null; }; /** Format: uri */ html_url: string; @@ -30400,6 +30935,7 @@ export interface components { performed_via_github_app?: components["schemas"]["nullable-integration"]; author_association: components["schemas"]["author-association"]; reactions?: components["schemas"]["reaction-rollup"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; } | null; /** * Issue Event Label @@ -30978,6 +31514,7 @@ export interface components { reason: string; signature: string | null; payload: string | null; + verified_at?: string | null; }; /** Format: uri */ html_url: string; @@ -32114,6 +32651,16 @@ export interface components { * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ push_protection_bypassed_at?: string | null; + push_protection_bypass_request_reviewer?: components["schemas"]["nullable-simple-user"]; + /** @description An optional comment when reviewing a push protection bypass. */ + push_protection_bypass_request_reviewer_comment?: string | null; + /** @description An optional comment when requesting a push protection bypass. */ + push_protection_bypass_request_comment?: string | null; + /** + * Format: uri + * @description The URL to a push protection bypass request. + */ + push_protection_bypass_request_html_url?: string | null; /** * @description The token status as of the latest validity check. * @enum {string} @@ -32251,7 +32798,7 @@ export interface components { /** * Format: uri * @description The API URL to get the pull request where the secret was detected. - * @example https://api.github.com/repos/octocat/Hello-World/pull/2846 + * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846 */ pull_request_title_url: string; }; @@ -32260,7 +32807,7 @@ export interface components { /** * Format: uri * @description The API URL to get the pull request where the secret was detected. - * @example https://api.github.com/repos/octocat/Hello-World/pull/2846 + * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846 */ pull_request_body_url: string; }; @@ -32315,6 +32862,34 @@ export interface components { /** @description The token type this bypass is for. */ token_type?: string; }; + /** @description Information on a single scan performed by secret scanning on the repository */ + "secret-scanning-scan": { + /** @description The type of scan */ + type?: string; + /** @description The state of the scan. Either "completed", "running", or "pending" */ + status?: string; + /** + * Format: date-time + * @description The time that the scan was completed. Empty if the scan is running + */ + completed_at?: string | null; + /** + * Format: date-time + * @description The time that the scan was started. Empty if the scan is pending + */ + started_at?: string | null; + }; + "secret-scanning-scan-history": { + incremental_scans?: components["schemas"]["secret-scanning-scan"][]; + pattern_update_scans?: components["schemas"]["secret-scanning-scan"][]; + backfill_scans?: components["schemas"]["secret-scanning-scan"][]; + custom_pattern_backfill_scans?: (components["schemas"]["secret-scanning-scan"] & { + /** @description Name of the custom pattern for custom pattern scans */ + pattern_name?: string; + /** @description Level at which the custom pattern is defined, one of "repository", "organization", or "enterprise" */ + pattern_scope?: string; + })[]; + }; "repository-advisory-create": { /** @description A short summary of the advisory. */ summary: string; @@ -32749,6 +33324,12 @@ export interface components { default?: boolean; description?: string | null; }[]; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; state: string; state_reason?: string | null; assignee: components["schemas"]["nullable-simple-user"]; @@ -35340,6 +35921,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -35828,6 +36415,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -38908,6 +39501,16 @@ export interface components { * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ push_protection_bypassed_at?: string | null; + push_protection_bypass_request_reviewer?: components["schemas"]["nullable-simple-user"]; + /** @description An optional comment when reviewing a push protection bypass. */ + push_protection_bypass_request_reviewer_comment?: string | null; + /** @description An optional comment when requesting a push protection bypass. */ + push_protection_bypass_request_comment?: string | null; + /** + * Format: uri + * @description The URL to a push protection bypass request. + */ + push_protection_bypass_request_html_url?: string | null; /** @description Whether the detected secret was publicly leaked. */ publicly_leaked?: boolean | null; /** @description Whether the detected secret was found in multiple repositories in the same organization or business. */ @@ -44426,6 +45029,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -44964,6 +45573,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -45504,6 +46119,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -46059,6 +46680,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -46545,6 +47172,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -46969,6 +47602,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -47406,6 +48045,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -47832,6 +48477,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -48260,6 +48911,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -48684,6 +49341,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -49110,6 +49773,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -49776,6 +50445,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -50211,6 +50886,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -50636,6 +51317,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -51344,6 +52031,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -82571,6 +83264,45 @@ export interface components { repository: components["schemas"]["repository-webhooks"]; sender?: components["schemas"]["simple-user"]; }; + /** secret_scanning_scan completed event */ + "webhook-secret-scanning-scan-completed": { + /** @enum {string} */ + action: "completed"; + /** + * @description What type of scan was completed + * @enum {string} + */ + type: "backfill" | "custom-pattern-backfill" | "pattern-version-backfill"; + /** + * @description What type of content was scanned + * @enum {string} + */ + source: "git" | "issues" | "pull-requests" | "discussions" | "wiki"; + /** + * Format: date-time + * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + started_at: string; + /** + * Format: date-time + * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + completed_at: string; + /** @description List of patterns that were updated. This will be empty for normal backfill scans or custom pattern updates */ + secret_types?: string[] | null; + /** @description If the scan was triggered by a custom pattern update, this will be the name of the pattern that was updated */ + custom_pattern_name?: string | null; + /** + * @description If the scan was triggered by a custom pattern update, this will be the scope of the pattern that was updated + * @enum {string|null} + */ + custom_pattern_scope?: "repository" | "organization" | "enterprise" | null; + repository?: components["schemas"]["repository-webhooks"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + sender?: components["schemas"]["simple-user"]; + }; /** security_advisory published event */ "webhook-security-advisory-published": { /** @enum {string} */ @@ -82850,6 +83582,7 @@ export interface components { reason: "expired_key" | "not_signing_key" | "gpgverify_error" | "gpgverify_unavailable" | "unsigned" | "unknown_signature_type" | "no_user" | "unverified_email" | "bad_email" | "unknown_key" | "malformed_signature" | "invalid" | "valid" | "bad_cert" | "ocsp_pending"; signature: string | null; verified: boolean; + verified_at?: string | null; }; }; /** User */ @@ -86045,8 +86778,8 @@ export interface components { "application/json": components["schemas"]["basic-error"]; }; }; - /** @description Internal Error */ - internal_error: { + /** @description Conflict */ + conflict: { headers: { [name: string]: unknown; }; @@ -86054,14 +86787,12 @@ export interface components { "application/json": components["schemas"]["basic-error"]; }; }; - /** @description Copilot Usage Merics API setting is disabled at the organization or enterprise level. */ - usage_metrics_api_disabled: { + /** @description A header with no content is returned. */ + no_content: { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["basic-error"]; - }; + content?: never; }; /** @description Service unavailable */ service_unavailable: { @@ -86102,8 +86833,17 @@ export interface components { "application/json": components["schemas"]["basic-error"]; }; }; - /** @description Conflict */ - conflict: { + /** @description Billing usage report response for an organization */ + billing_usage_report_org: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["billing-usage-report"]; + }; + }; + /** @description Internal Error */ + internal_error: { headers: { [name: string]: unknown; }; @@ -86148,12 +86888,14 @@ export interface components { }; }; }; - /** @description A header with no content is returned. */ - no_content: { + /** @description Copilot Usage Merics API setting is disabled at the organization or enterprise level. */ + usage_metrics_api_disabled: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["basic-error"]; + }; }; /** @description The value of `per_page` multiplied by `page` cannot be greater than 10000. */ package_es_list_error: { @@ -86198,6 +86940,24 @@ export interface components { "application/json": components["schemas"]["basic-error"]; }; }; + /** @description Bad Request */ + code_scanning_bad_request: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + /** @description Response if the repository is archived, if GitHub Advanced Security is not enabled for this repository or if rate limit is exceeded */ + code_scanning_autofix_create_forbidden: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; /** @description Found */ found: { headers: { @@ -86271,6 +87031,8 @@ export interface components { "classroom-id": number; /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: string; + /** @description The unique identifier of the code security configuration. */ + "configuration-id": number; /** @description A comma-separated list of states. If specified, only alerts with these states will be returned. * * Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` */ @@ -86301,9 +87063,7 @@ export interface components { "pagination-last": number; /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ "secret-scanning-alert-state": "open" | "resolved"; - /** @description A comma-separated list of secret types to return. By default all secret types are returned. - * See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" - * for a complete list of secret types. */ + /** @description A comma-separated list of secret types to return. All default secret patterns are returned. To return experimental patterns, pass the token name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. */ "secret-scanning-alert-secret-type": string; /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ "secret-scanning-alert-resolution": string; @@ -86315,10 +87075,6 @@ export interface components { "secret-scanning-alert-publicly-leaked": boolean; /** @description A boolean value representing whether or not to filter alerts by the multi-repo tag being present. */ "secret-scanning-alert-multi-repo": boolean; - /** @description The slug of the enterprise team name. */ - "enterprise-team-slug": string; - /** @description The slug of the team name. */ - "team-slug": string; /** @description The unique identifier of the gist. */ "gist-id": string; /** @description The unique identifier of the comment. */ @@ -86347,6 +87103,14 @@ export interface components { "since-org": number; /** @description The organization name. The name is not case sensitive. */ org: string; + /** @description If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2024`. Default value is the current year. */ + "billing-usage-report-year": number; + /** @description If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. */ + "billing-usage-report-month": number; + /** @description If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. */ + "billing-usage-report-day": number; + /** @description If specified, only return results for a single hour. The value of `hour` is an integer between `0` and `23`. */ + "billing-usage-report-hour": number; /** @description The unique identifier of the repository. */ "repository-id": number; /** @description Only return runner groups that are allowed to be used by this repository. */ @@ -86369,26 +87133,30 @@ export interface components { "tool-name": components["schemas"]["code-scanning-analysis-tool-name"]; /** @description The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both. */ "tool-guid": components["schemas"]["code-scanning-analysis-tool-guid"]; - /** @description The unique identifier of the code security configuration. */ - "configuration-id": number; /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ "hook-id": number; /** @description The type of the actor */ - "api-insights-actor-type": "installations" | "classic_pats" | "fine_grained_pats" | "oauth_apps" | "github_apps_user_to_server"; + "api-insights-actor-type": "installation" | "classic_pat" | "fine_grained_pat" | "oauth_app" | "github_app_user_to_server"; /** @description The ID of the actor */ "api-insights-actor-id": number; - /** @description The minimum timestamp to query for stats */ + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ "api-insights-min-timestamp": string; - /** @description The maximum timestamp to query for stats */ + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ "api-insights-max-timestamp": string; /** @description The property to sort the results by. */ "api-insights-route-stats-sort": ("last_rate_limited_timestamp" | "last_request_timestamp" | "rate_limited_request_count" | "http_method" | "api_route" | "total_request_count")[]; + /** @description Providing a substring will filter results where the API route contains the substring. This is a case-insensitive search. */ + "api-insights-api-route-substring": string; /** @description The property to sort the results by. */ "api-insights-sort": ("last_rate_limited_timestamp" | "last_request_timestamp" | "rate_limited_request_count" | "subject_name" | "total_request_count")[]; + /** @description Providing a substring will filter results where the subject name contains the substring. This is a case-insensitive search. */ + "api-insights-subject-name-substring": string; /** @description The ID of the user to query for stats */ "api-insights-user-id": string; /** @description The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) */ "api-insights-timestamp-increment": string; + /** @description Providing a substring will filter results where the actor name contains the substring. This is a case-insensitive search. */ + "api-insights-actor-name-substring": string; /** @description The unique identifier of the invitation. */ "invitation-id": number; /** @description The name of the codespace. */ @@ -86397,6 +87165,8 @@ export interface components { "migration-id": number; /** @description repo_name parameter */ "repo-name": string; + /** @description The slug of the team name. */ + "team-slug": string; /** @description The unique identifier of the role. */ "role-id": number; /** @description The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -86433,8 +87203,8 @@ export interface components { "ruleset-targets": string; /** @description The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. */ "ref-in-query": string; - /** @description The name of the repository to filter on. When specified, only rule evaluations from this repository will be returned. */ - "repository-name-in-query": number; + /** @description The name of the repository to filter on. */ + "repository-name-in-query": string; /** @description The time period to filter by. * * For example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for insights that occurred in the past 7 days (168 hours). */ @@ -86654,17 +87424,11 @@ export type SchemaSimpleClassroomAssignment = components['schemas']['simple-clas export type SchemaClassroomAcceptedAssignment = components['schemas']['classroom-accepted-assignment']; export type SchemaClassroomAssignmentGrade = components['schemas']['classroom-assignment-grade']; export type SchemaCodeOfConduct = components['schemas']['code-of-conduct']; -export type SchemaNullableOrganizationSimple = components['schemas']['nullable-organization-simple']; -export type SchemaNullableTeamSimple = components['schemas']['nullable-team-simple']; -export type SchemaTeam = components['schemas']['team']; -export type SchemaEnterpriseTeam = components['schemas']['enterprise-team']; -export type SchemaCopilotSeatDetails = components['schemas']['copilot-seat-details']; -export type SchemaCopilotIdeCodeCompletions = components['schemas']['copilot-ide-code-completions']; -export type SchemaCopilotIdeChat = components['schemas']['copilot-ide-chat']; -export type SchemaCopilotDotcomChat = components['schemas']['copilot-dotcom-chat']; -export type SchemaCopilotDotcomPullRequests = components['schemas']['copilot-dotcom-pull-requests']; -export type SchemaCopilotUsageMetricsDay = components['schemas']['copilot-usage-metrics-day']; -export type SchemaCopilotUsageMetrics = components['schemas']['copilot-usage-metrics']; +export type SchemaCodeSecurityConfiguration = components['schemas']['code-security-configuration']; +export type SchemaCodeScanningDefaultSetupOptions = components['schemas']['code-scanning-default-setup-options']; +export type SchemaCodeSecurityDefaultConfigurations = components['schemas']['code-security-default-configurations']; +export type SchemaSimpleRepository = components['schemas']['simple-repository']; +export type SchemaCodeSecurityConfigurationRepositories = components['schemas']['code-security-configuration-repositories']; export type SchemaAlertNumber = components['schemas']['alert-number']; export type SchemaDependabotAlertPackage = components['schemas']['dependabot-alert-package']; export type SchemaDependabotAlertSecurityVulnerability = components['schemas']['dependabot-alert-security-vulnerability']; @@ -86676,7 +87440,6 @@ export type SchemaAlertUpdatedAt = components['schemas']['alert-updated-at']; export type SchemaAlertDismissedAt = components['schemas']['alert-dismissed-at']; export type SchemaAlertFixedAt = components['schemas']['alert-fixed-at']; export type SchemaAlertAutoDismissedAt = components['schemas']['alert-auto-dismissed-at']; -export type SchemaSimpleRepository = components['schemas']['simple-repository']; export type SchemaDependabotAlertWithRepository = components['schemas']['dependabot-alert-with-repository']; export type SchemaNullableAlertUpdatedAt = components['schemas']['nullable-alert-updated-at']; export type SchemaSecretScanningAlertState = components['schemas']['secret-scanning-alert-state']; @@ -86687,6 +87450,7 @@ export type SchemaNullableMilestone = components['schemas']['nullable-milestone' export type SchemaNullableIntegration = components['schemas']['nullable-integration']; export type SchemaAuthorAssociation = components['schemas']['author-association']; export type SchemaReactionRollup = components['schemas']['reaction-rollup']; +export type SchemaSubIssuesSummary = components['schemas']['sub-issues-summary']; export type SchemaIssue = components['schemas']['issue']; export type SchemaIssueComment = components['schemas']['issue-comment']; export type SchemaEvent = components['schemas']['event']; @@ -86709,6 +87473,7 @@ export type SchemaMinimalRepository = components['schemas']['minimal-repository' export type SchemaThread = components['schemas']['thread']; export type SchemaThreadSubscription = components['schemas']['thread-subscription']; export type SchemaOrganizationSimple = components['schemas']['organization-simple']; +export type SchemaBillingUsageReport = components['schemas']['billing-usage-report']; export type SchemaOrganizationFull = components['schemas']['organization-full']; export type SchemaActionsCacheUsageOrgEnterprise = components['schemas']['actions-cache-usage-org-enterprise']; export type SchemaActionsCacheUsageByRepository = components['schemas']['actions-cache-usage-by-repository']; @@ -86750,15 +87515,23 @@ export type SchemaCodeScanningAlertLocation = components['schemas']['code-scanni export type SchemaCodeScanningAlertClassification = components['schemas']['code-scanning-alert-classification']; export type SchemaCodeScanningAlertInstance = components['schemas']['code-scanning-alert-instance']; export type SchemaCodeScanningOrganizationAlertItems = components['schemas']['code-scanning-organization-alert-items']; -export type SchemaCodeSecurityConfiguration = components['schemas']['code-security-configuration']; -export type SchemaCodeSecurityDefaultConfigurations = components['schemas']['code-security-default-configurations']; -export type SchemaCodeSecurityConfigurationRepositories = components['schemas']['code-security-configuration-repositories']; export type SchemaNullableCodespaceMachine = components['schemas']['nullable-codespace-machine']; export type SchemaCodespace = components['schemas']['codespace']; export type SchemaCodespacesOrgSecret = components['schemas']['codespaces-org-secret']; export type SchemaCodespacesPublicKey = components['schemas']['codespaces-public-key']; export type SchemaCopilotSeatBreakdown = components['schemas']['copilot-seat-breakdown']; export type SchemaCopilotOrganizationDetails = components['schemas']['copilot-organization-details']; +export type SchemaNullableOrganizationSimple = components['schemas']['nullable-organization-simple']; +export type SchemaNullableTeamSimple = components['schemas']['nullable-team-simple']; +export type SchemaTeam = components['schemas']['team']; +export type SchemaEnterpriseTeam = components['schemas']['enterprise-team']; +export type SchemaCopilotSeatDetails = components['schemas']['copilot-seat-details']; +export type SchemaCopilotIdeCodeCompletions = components['schemas']['copilot-ide-code-completions']; +export type SchemaCopilotIdeChat = components['schemas']['copilot-ide-chat']; +export type SchemaCopilotDotcomChat = components['schemas']['copilot-dotcom-chat']; +export type SchemaCopilotDotcomPullRequests = components['schemas']['copilot-dotcom-pull-requests']; +export type SchemaCopilotUsageMetricsDay = components['schemas']['copilot-usage-metrics-day']; +export type SchemaCopilotUsageMetrics = components['schemas']['copilot-usage-metrics']; export type SchemaOrganizationDependabotSecret = components['schemas']['organization-dependabot-secret']; export type SchemaDependabotPublicKey = components['schemas']['dependabot-public-key']; export type SchemaNullableMinimalRepository = components['schemas']['nullable-minimal-repository']; @@ -86783,8 +87556,11 @@ export type SchemaUserRoleAssignment = components['schemas']['user-role-assignme export type SchemaPackageVersion = components['schemas']['package-version']; export type SchemaOrganizationProgrammaticAccessGrantRequest = components['schemas']['organization-programmatic-access-grant-request']; export type SchemaOrganizationProgrammaticAccessGrant = components['schemas']['organization-programmatic-access-grant']; +export type SchemaOrgPrivateRegistryConfiguration = components['schemas']['org-private-registry-configuration']; +export type SchemaOrgPrivateRegistryConfigurationWithSelectedRepositories = components['schemas']['org-private-registry-configuration-with-selected-repositories']; export type SchemaProject = components['schemas']['project']; export type SchemaCustomProperty = components['schemas']['custom-property']; +export type SchemaCustomPropertySetPayload = components['schemas']['custom-property-set-payload']; export type SchemaCustomPropertyValue = components['schemas']['custom-property-value']; export type SchemaOrgRepoCustomPropertyValues = components['schemas']['org-repo-custom-property-values']; export type SchemaNullableRepository = components['schemas']['nullable-repository']; @@ -86891,6 +87667,12 @@ export type SchemaCodeScanningAlertItems = components['schemas']['code-scanning- export type SchemaCodeScanningAlertRule = components['schemas']['code-scanning-alert-rule']; export type SchemaCodeScanningAlert = components['schemas']['code-scanning-alert']; export type SchemaCodeScanningAlertSetState = components['schemas']['code-scanning-alert-set-state']; +export type SchemaCodeScanningAutofixStatus = components['schemas']['code-scanning-autofix-status']; +export type SchemaCodeScanningAutofixDescription = components['schemas']['code-scanning-autofix-description']; +export type SchemaCodeScanningAutofixStartedAt = components['schemas']['code-scanning-autofix-started-at']; +export type SchemaCodeScanningAutofix = components['schemas']['code-scanning-autofix']; +export type SchemaCodeScanningAutofixCommits = components['schemas']['code-scanning-autofix-commits']; +export type SchemaCodeScanningAutofixCommitsResponse = components['schemas']['code-scanning-autofix-commits-response']; export type SchemaCodeScanningAnalysisSarifId = components['schemas']['code-scanning-analysis-sarif-id']; export type SchemaCodeScanningAnalysisCommitSha = components['schemas']['code-scanning-analysis-commit-sha']; export type SchemaCodeScanningAnalysisEnvironment = components['schemas']['code-scanning-analysis-environment']; @@ -87047,6 +87829,8 @@ export type SchemaSecretScanningLocationPullRequestReviewComment = components['s export type SchemaSecretScanningLocation = components['schemas']['secret-scanning-location']; export type SchemaSecretScanningPushProtectionBypassReason = components['schemas']['secret-scanning-push-protection-bypass-reason']; export type SchemaSecretScanningPushProtectionBypass = components['schemas']['secret-scanning-push-protection-bypass']; +export type SchemaSecretScanningScan = components['schemas']['secret-scanning-scan']; +export type SchemaSecretScanningScanHistory = components['schemas']['secret-scanning-scan-history']; export type SchemaRepositoryAdvisoryCreate = components['schemas']['repository-advisory-create']; export type SchemaPrivateVulnerabilityReportCreate = components['schemas']['private-vulnerability-report-create']; export type SchemaRepositoryAdvisoryUpdate = components['schemas']['repository-advisory-update']; @@ -87378,6 +88162,7 @@ export type SchemaWebhookSecretScanningAlertPubliclyLeaked = components['schemas export type SchemaWebhookSecretScanningAlertReopened = components['schemas']['webhook-secret-scanning-alert-reopened']; export type SchemaWebhookSecretScanningAlertResolved = components['schemas']['webhook-secret-scanning-alert-resolved']; export type SchemaWebhookSecretScanningAlertValidated = components['schemas']['webhook-secret-scanning-alert-validated']; +export type SchemaWebhookSecretScanningScanCompleted = components['schemas']['webhook-secret-scanning-scan-completed']; export type SchemaWebhookSecurityAdvisoryPublished = components['schemas']['webhook-security-advisory-published']; export type SchemaWebhookSecurityAdvisoryUpdated = components['schemas']['webhook-security-advisory-updated']; export type SchemaWebhookSecurityAdvisoryWithdrawn = components['schemas']['webhook-security-advisory-withdrawn']; @@ -87418,21 +88203,24 @@ export type ResponseAccepted = components['responses']['accepted']; export type ResponseNotModified = components['responses']['not_modified']; export type ResponseRequiresAuthentication = components['responses']['requires_authentication']; export type ResponseForbidden = components['responses']['forbidden']; -export type ResponseInternalError = components['responses']['internal_error']; -export type ResponseUsageMetricsApiDisabled = components['responses']['usage_metrics_api_disabled']; +export type ResponseConflict = components['responses']['conflict']; +export type ResponseNoContent = components['responses']['no_content']; export type ResponseServiceUnavailable = components['responses']['service_unavailable']; export type ResponseForbiddenGist = components['responses']['forbidden_gist']; export type ResponseMovedPermanently = components['responses']['moved_permanently']; -export type ResponseConflict = components['responses']['conflict']; +export type ResponseBillingUsageReportOrg = components['responses']['billing_usage_report_org']; +export type ResponseInternalError = components['responses']['internal_error']; export type ResponseActionsRunnerJitconfig = components['responses']['actions_runner_jitconfig']; export type ResponseActionsRunnerLabels = components['responses']['actions_runner_labels']; export type ResponseActionsRunnerLabelsReadonly = components['responses']['actions_runner_labels_readonly']; -export type ResponseNoContent = components['responses']['no_content']; +export type ResponseUsageMetricsApiDisabled = components['responses']['usage_metrics_api_disabled']; export type ResponsePackageEsListError = components['responses']['package_es_list_error']; export type ResponseGone = components['responses']['gone']; export type ResponseTemporaryRedirect = components['responses']['temporary_redirect']; export type ResponseCodeScanningForbiddenRead = components['responses']['code_scanning_forbidden_read']; export type ResponseCodeScanningForbiddenWrite = components['responses']['code_scanning_forbidden_write']; +export type ResponseCodeScanningBadRequest = components['responses']['code_scanning_bad_request']; +export type ResponseCodeScanningAutofixCreateForbidden = components['responses']['code_scanning_autofix_create_forbidden']; export type ResponseFound = components['responses']['found']; export type ResponseCodeScanningConflict = components['responses']['code_scanning_conflict']; export type ResponseDependencyReviewForbidden = components['responses']['dependency_review_forbidden']; @@ -87453,6 +88241,7 @@ export type ParameterAppSlug = components['parameters']['app-slug']; export type ParameterAssignmentId = components['parameters']['assignment-id']; export type ParameterClassroomId = components['parameters']['classroom-id']; export type ParameterEnterprise = components['parameters']['enterprise']; +export type ParameterConfigurationId = components['parameters']['configuration-id']; export type ParameterDependabotAlertCommaSeparatedStates = components['parameters']['dependabot-alert-comma-separated-states']; export type ParameterDependabotAlertCommaSeparatedSeverities = components['parameters']['dependabot-alert-comma-separated-severities']; export type ParameterDependabotAlertCommaSeparatedEcosystems = components['parameters']['dependabot-alert-comma-separated-ecosystems']; @@ -87468,8 +88257,6 @@ export type ParameterSecretScanningAlertSort = components['parameters']['secret- export type ParameterSecretScanningAlertValidity = components['parameters']['secret-scanning-alert-validity']; export type ParameterSecretScanningAlertPubliclyLeaked = components['parameters']['secret-scanning-alert-publicly-leaked']; export type ParameterSecretScanningAlertMultiRepo = components['parameters']['secret-scanning-alert-multi-repo']; -export type ParameterEnterpriseTeamSlug = components['parameters']['enterprise-team-slug']; -export type ParameterTeamSlug = components['parameters']['team-slug']; export type ParameterGistId = components['parameters']['gist-id']; export type ParameterCommentId = components['parameters']['comment-id']; export type ParameterLabels = components['parameters']['labels']; @@ -87484,6 +88271,10 @@ export type ParameterBefore = components['parameters']['before']; export type ParameterThreadId = components['parameters']['thread-id']; export type ParameterSinceOrg = components['parameters']['since-org']; export type ParameterOrg = components['parameters']['org']; +export type ParameterBillingUsageReportYear = components['parameters']['billing-usage-report-year']; +export type ParameterBillingUsageReportMonth = components['parameters']['billing-usage-report-month']; +export type ParameterBillingUsageReportDay = components['parameters']['billing-usage-report-day']; +export type ParameterBillingUsageReportHour = components['parameters']['billing-usage-report-hour']; export type ParameterRepositoryId = components['parameters']['repository-id']; export type ParameterVisibleToRepository = components['parameters']['visible-to-repository']; export type ParameterRunnerGroupId = components['parameters']['runner-group-id']; @@ -87495,20 +88286,23 @@ export type ParameterVariableName = components['parameters']['variable-name']; export type ParameterUsername = components['parameters']['username']; export type ParameterToolName = components['parameters']['tool-name']; export type ParameterToolGuid = components['parameters']['tool-guid']; -export type ParameterConfigurationId = components['parameters']['configuration-id']; export type ParameterHookId = components['parameters']['hook-id']; export type ParameterApiInsightsActorType = components['parameters']['api-insights-actor-type']; export type ParameterApiInsightsActorId = components['parameters']['api-insights-actor-id']; export type ParameterApiInsightsMinTimestamp = components['parameters']['api-insights-min-timestamp']; export type ParameterApiInsightsMaxTimestamp = components['parameters']['api-insights-max-timestamp']; export type ParameterApiInsightsRouteStatsSort = components['parameters']['api-insights-route-stats-sort']; +export type ParameterApiInsightsApiRouteSubstring = components['parameters']['api-insights-api-route-substring']; export type ParameterApiInsightsSort = components['parameters']['api-insights-sort']; +export type ParameterApiInsightsSubjectNameSubstring = components['parameters']['api-insights-subject-name-substring']; export type ParameterApiInsightsUserId = components['parameters']['api-insights-user-id']; export type ParameterApiInsightsTimestampIncrement = components['parameters']['api-insights-timestamp-increment']; +export type ParameterApiInsightsActorNameSubstring = components['parameters']['api-insights-actor-name-substring']; export type ParameterInvitationId = components['parameters']['invitation-id']; export type ParameterCodespaceName = components['parameters']['codespace-name']; export type ParameterMigrationId = components['parameters']['migration-id']; export type ParameterRepoName = components['parameters']['repo-name']; +export type ParameterTeamSlug = components['parameters']['team-slug']; export type ParameterRoleId = components['parameters']['role-id']; export type ParameterPackageVisibility = components['parameters']['package-visibility']; export type ParameterPackageType = components['parameters']['package-type']; @@ -88509,13 +89303,15 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; - "copilot/list-copilot-seats-for-enterprise": { + "code-security/get-configurations-for-enterprise": { parameters: { query?: { - /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - page?: components["parameters"]["page"]; /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: number; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + before?: components["parameters"]["pagination-before"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + after?: components["parameters"]["pagination-after"]; }; header?: never; path: { @@ -88529,39 +89325,164 @@ export interface operations { /** @description Response */ 200: { headers: { - Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": { - /** @description The total number of Copilot seats the enterprise is being billed for. Users with access through multiple organizations or enterprise teams are only counted once. */ - total_seats?: number; - seats?: components["schemas"]["copilot-seat-details"][]; + "application/json": components["schemas"]["code-security-configuration"][]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "code-security/create-configuration-for-enterprise": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + enterprise: components["parameters"]["enterprise"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description The name of the code security configuration. Must be unique within the enterprise. */ + name: string; + /** @description A description of the code security configuration */ + description: string; + /** + * @description The enablement status of GitHub Advanced Security + * @default disabled + * @enum {string} + */ + advanced_security?: "enabled" | "disabled"; + /** + * @description The enablement status of Dependency Graph + * @default enabled + * @enum {string} + */ + dependency_graph?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Automatic dependency submission + * @default disabled + * @enum {string} + */ + dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for Automatic dependency submission */ + dependency_graph_autosubmit_action_options?: { + /** + * @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. + * @default false + */ + labeled_runners?: boolean; }; + /** + * @description The enablement status of Dependabot alerts + * @default disabled + * @enum {string} + */ + dependabot_alerts?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot security updates + * @default disabled + * @enum {string} + */ + dependabot_security_updates?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of code scanning default setup + * @default disabled + * @enum {string} + */ + code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; + code_scanning_default_setup_options?: components["schemas"]["code-scanning-default-setup-options"]; + /** + * @description The enablement status of secret scanning + * @default disabled + * @enum {string} + */ + secret_scanning?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning push protection + * @default disabled + * @enum {string} + */ + secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning validity checks + * @default disabled + * @enum {string} + */ + secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning non provider patterns + * @default disabled + * @enum {string} + */ + secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of private vulnerability reporting + * @default disabled + * @enum {string} + */ + private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; + /** + * @description The enforcement status for a security configuration + * @default enforced + * @enum {string} + */ + enforcement?: "enforced" | "unenforced"; }; }; - 401: components["responses"]["requires_authentication"]; + }; + responses: { + /** @description Successfully created code security configuration */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["code-security-configuration"]; + }; + }; + 400: components["responses"]["bad_request"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; }; }; - "copilot/copilot-metrics-for-enterprise": { + "code-security/get-default-configurations-for-enterprise": { parameters: { - query?: { - /** @description Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago. */ - since?: string; - /** @description Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed. */ - until?: string; - /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - page?: components["parameters"]["page"]; - /** @description The number of days of metrics to display per page (max 28). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - per_page?: number; + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + enterprise: components["parameters"]["enterprise"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["code-security-default-configurations"]; + }; }; + }; + }; + "code-security/get-single-configuration-for-enterprise": { + parameters: { + query?: never; header?: never; path: { /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description The unique identifier of the code security configuration. */ + configuration_id: components["parameters"]["configuration-id"]; }; cookie?: never; }; @@ -88573,31 +89494,233 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["copilot-usage-metrics-day"][]; + "application/json": components["schemas"]["code-security-configuration"]; }; }; + 304: components["responses"]["not_modified"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - 422: components["responses"]["usage_metrics_api_disabled"]; - 500: components["responses"]["internal_error"]; }; }; - "copilot/usage-metrics-for-enterprise": { + "code-security/delete-configuration-for-enterprise": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The unique identifier of the code security configuration. */ + configuration_id: components["parameters"]["configuration-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 204: components["responses"]["no_content"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + }; + }; + "code-security/update-enterprise-configuration": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The unique identifier of the code security configuration. */ + configuration_id: components["parameters"]["configuration-id"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description The name of the code security configuration. Must be unique across the enterprise. */ + name?: string; + /** @description A description of the code security configuration */ + description?: string; + /** + * @description The enablement status of GitHub Advanced Security. Must be set to enabled if you want to enable any GHAS settings. + * @enum {string} + */ + advanced_security?: "enabled" | "disabled"; + /** + * @description The enablement status of Dependency Graph + * @enum {string} + */ + dependency_graph?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Automatic dependency submission + * @enum {string} + */ + dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for Automatic dependency submission */ + dependency_graph_autosubmit_action_options?: { + /** @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. */ + labeled_runners?: boolean; + }; + /** + * @description The enablement status of Dependabot alerts + * @enum {string} + */ + dependabot_alerts?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot security updates + * @enum {string} + */ + dependabot_security_updates?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of code scanning default setup + * @enum {string} + */ + code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; + code_scanning_default_setup_options?: components["schemas"]["code-scanning-default-setup-options"]; + /** + * @description The enablement status of secret scanning + * @enum {string} + */ + secret_scanning?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning push protection + * @enum {string} + */ + secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning validity checks + * @enum {string} + */ + secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning non-provider patterns + * @enum {string} + */ + secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of private vulnerability reporting + * @enum {string} + */ + private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; + /** + * @description The enforcement status for a security configuration + * @enum {string} + */ + enforcement?: "enforced" | "unenforced"; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["code-security-configuration"]; + }; + }; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + }; + }; + "code-security/attach-enterprise-configuration": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The unique identifier of the code security configuration. */ + configuration_id: components["parameters"]["configuration-id"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** + * @description The type of repositories to attach the configuration to. `selected` means the configuration will be attached to only the repositories specified by `selected_repository_ids` + * @enum {string} + */ + scope: "all" | "all_without_configurations"; + }; + }; + }; + responses: { + 202: components["responses"]["accepted"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + }; + }; + "code-security/set-configuration-as-default-for-enterprise": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The unique identifier of the code security configuration. */ + configuration_id: components["parameters"]["configuration-id"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** + * @description Specify which types of repository this security configuration should be applied to by default. + * @enum {string} + */ + default_for_new_repos?: "all" | "none" | "private_and_internal" | "public"; + }; + }; + }; + responses: { + /** @description Default successfully changed. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * @description Specifies which types of repository this security configuration is applied to by default. + * @enum {string} + */ + default_for_new_repos?: "all" | "none" | "private_and_internal" | "public"; + configuration?: components["schemas"]["code-security-configuration"]; + }; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "code-security/get-repositories-for-enterprise-configuration": { parameters: { query?: { - /** @description Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago. */ - since?: string; - /** @description Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed. */ - until?: string; - /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - page?: components["parameters"]["page"]; - /** @description The number of days of metrics to display per page (max 28). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: number; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + before?: components["parameters"]["pagination-before"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + after?: components["parameters"]["pagination-after"]; + /** @description A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned. + * + * Can be: `all`, `attached`, `attaching`, `removed`, `enforced`, `failed`, `updating`, `removed_by_enterprise` */ + status?: string; }; header?: never; path: { /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description The unique identifier of the code security configuration. */ + configuration_id: components["parameters"]["configuration-id"]; }; cookie?: never; }; @@ -88609,13 +89732,11 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["copilot-usage-metrics"][]; + "application/json": components["schemas"]["code-security-configuration-repositories"][]; }; }; - 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; }; }; "dependabot/list-alerts-for-enterprise": { @@ -88687,9 +89808,7 @@ export interface operations { query?: { /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ state?: components["parameters"]["secret-scanning-alert-state"]; - /** @description A comma-separated list of secret types to return. By default all secret types are returned. - * See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" - * for a complete list of secret types. */ + /** @description A comma-separated list of secret types to return. All default secret patterns are returned. To return experimental patterns, pass the token name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. */ secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ resolution?: components["parameters"]["secret-scanning-alert-resolution"]; @@ -88733,82 +89852,6 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - "copilot/copilot-metrics-for-enterprise-team": { - parameters: { - query?: { - /** @description Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago. */ - since?: string; - /** @description Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed. */ - until?: string; - /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - page?: components["parameters"]["page"]; - /** @description The number of days of metrics to display per page (max 28). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - per_page?: number; - }; - header?: never; - path: { - /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - /** @description The slug of the enterprise team name. */ - team_slug: components["parameters"]["enterprise-team-slug"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["copilot-usage-metrics-day"][]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["usage_metrics_api_disabled"]; - 500: components["responses"]["internal_error"]; - }; - }; - "copilot/usage-metrics-for-enterprise-team": { - parameters: { - query?: { - /** @description Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago. */ - since?: string; - /** @description Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed. */ - until?: string; - /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - page?: components["parameters"]["page"]; - /** @description The number of days of metrics to display per page (max 28). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - per_page?: number; - }; - header?: never; - path: { - /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - /** @description The slug of the team name. */ - team_slug: components["parameters"]["team-slug"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["copilot-usage-metrics"][]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; - }; - }; "activity/list-public-events": { parameters: { query?: { @@ -90261,6 +91304,34 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; + "billing/get-github-billing-usage-report-org": { + parameters: { + query?: { + /** @description If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2024`. Default value is the current year. */ + year?: components["parameters"]["billing-usage-report-year"]; + /** @description If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. */ + month?: components["parameters"]["billing-usage-report-month"]; + /** @description If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. */ + day?: components["parameters"]["billing-usage-report-day"]; + /** @description If specified, only return results for a single hour. The value of `hour` is an integer between `0` and `23`. */ + hour?: components["parameters"]["billing-usage-report-hour"]; + }; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["billing_usage_report_org"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 500: components["responses"]["internal_error"]; + 503: components["responses"]["service_unavailable"]; + }; + }; "orgs/get": { parameters: { query?: never; @@ -92156,6 +93227,7 @@ export interface operations { }; }; repository_id?: number; + bundle_url?: string; }[]; }; }; @@ -92411,6 +93483,7 @@ export interface operations { * @enum {string} */ code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; + code_scanning_default_setup_options?: components["schemas"]["code-scanning-default-setup-options"]; /** * @description The enablement status of secret scanning * @default disabled @@ -92636,6 +93709,7 @@ export interface operations { * @enum {string} */ code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; + code_scanning_default_setup_options?: components["schemas"]["code-scanning-default-setup-options"]; /** * @description The enablement status of secret scanning * @enum {string} @@ -94363,10 +95437,10 @@ export interface operations { "api-insights/get-route-stats-by-actor": { parameters: { query: { - /** @description The minimum timestamp to query for stats */ + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ min_timestamp: components["parameters"]["api-insights-min-timestamp"]; - /** @description The maximum timestamp to query for stats */ - max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ @@ -94375,6 +95449,8 @@ export interface operations { direction?: components["parameters"]["direction"]; /** @description The property to sort the results by. */ sort?: components["parameters"]["api-insights-route-stats-sort"]; + /** @description Providing a substring will filter results where the API route contains the substring. This is a case-insensitive search. */ + api_route_substring?: components["parameters"]["api-insights-api-route-substring"]; }; header?: never; path: { @@ -94403,10 +95479,10 @@ export interface operations { "api-insights/get-subject-stats": { parameters: { query: { - /** @description The minimum timestamp to query for stats */ + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ min_timestamp: components["parameters"]["api-insights-min-timestamp"]; - /** @description The maximum timestamp to query for stats */ - max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ @@ -94415,6 +95491,8 @@ export interface operations { direction?: components["parameters"]["direction"]; /** @description The property to sort the results by. */ sort?: components["parameters"]["api-insights-sort"]; + /** @description Providing a substring will filter results where the subject name contains the substring. This is a case-insensitive search. */ + subject_name_substring?: components["parameters"]["api-insights-subject-name-substring"]; }; header?: never; path: { @@ -94439,10 +95517,10 @@ export interface operations { "api-insights/get-summary-stats": { parameters: { query: { - /** @description The minimum timestamp to query for stats */ + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ min_timestamp: components["parameters"]["api-insights-min-timestamp"]; - /** @description The maximum timestamp to query for stats */ - max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; }; header?: never; path: { @@ -94467,10 +95545,10 @@ export interface operations { "api-insights/get-summary-stats-by-user": { parameters: { query: { - /** @description The minimum timestamp to query for stats */ + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ min_timestamp: components["parameters"]["api-insights-min-timestamp"]; - /** @description The maximum timestamp to query for stats */ - max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; }; header?: never; path: { @@ -94497,10 +95575,10 @@ export interface operations { "api-insights/get-summary-stats-by-actor": { parameters: { query: { - /** @description The minimum timestamp to query for stats */ + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ min_timestamp: components["parameters"]["api-insights-min-timestamp"]; - /** @description The maximum timestamp to query for stats */ - max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; }; header?: never; path: { @@ -94529,10 +95607,10 @@ export interface operations { "api-insights/get-time-stats": { parameters: { query: { - /** @description The minimum timestamp to query for stats */ + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ min_timestamp: components["parameters"]["api-insights-min-timestamp"]; - /** @description The maximum timestamp to query for stats */ - max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; /** @description The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) */ timestamp_increment: components["parameters"]["api-insights-timestamp-increment"]; }; @@ -94559,10 +95637,10 @@ export interface operations { "api-insights/get-time-stats-by-user": { parameters: { query: { - /** @description The minimum timestamp to query for stats */ + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ min_timestamp: components["parameters"]["api-insights-min-timestamp"]; - /** @description The maximum timestamp to query for stats */ - max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; /** @description The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) */ timestamp_increment: components["parameters"]["api-insights-timestamp-increment"]; }; @@ -94591,10 +95669,10 @@ export interface operations { "api-insights/get-time-stats-by-actor": { parameters: { query: { - /** @description The minimum timestamp to query for stats */ + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ min_timestamp: components["parameters"]["api-insights-min-timestamp"]; - /** @description The maximum timestamp to query for stats */ - max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; /** @description The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) */ timestamp_increment: components["parameters"]["api-insights-timestamp-increment"]; }; @@ -94625,10 +95703,10 @@ export interface operations { "api-insights/get-user-stats": { parameters: { query: { - /** @description The minimum timestamp to query for stats */ + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ min_timestamp: components["parameters"]["api-insights-min-timestamp"]; - /** @description The maximum timestamp to query for stats */ - max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ @@ -94637,6 +95715,8 @@ export interface operations { direction?: components["parameters"]["direction"]; /** @description The property to sort the results by. */ sort?: components["parameters"]["api-insights-sort"]; + /** @description Providing a substring will filter results where the actor name contains the substring. This is a case-insensitive search. */ + actor_name_substring?: components["parameters"]["api-insights-actor-name-substring"]; }; header?: never; path: { @@ -96505,6 +97585,223 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; + "private-registries/list-org-private-registries": { + parameters: { + query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + page?: components["parameters"]["page"]; + }; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": { + total_count: number; + configurations: components["schemas"]["org-private-registry-configuration"][]; + }; + }; + }; + 400: components["responses"]["bad_request"]; + 404: components["responses"]["not_found"]; + }; + }; + "private-registries/create-org-private-registry": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** + * @description The registry type. + * @enum {string} + */ + registry_type: "maven_repository"; + /** @description The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication. */ + username?: string | null; + /** @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint. */ + encrypted_value: string; + /** @description The ID of the key you used to encrypt the secret. */ + key_id: string; + /** + * @description Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry. + * @enum {string} + */ + visibility: "all" | "private" | "selected"; + /** @description An array of repository IDs that can access the organization private registry. You can only provide a list of repository IDs when `visibility` is set to `selected`. You can manage the list of selected repositories using the [Update a private registry for an organization](https://docs.github.com/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization) endpoint. This field should be omitted if `visibility` is set to `all` or `private`. */ + selected_repository_ids?: number[]; + }; + }; + }; + responses: { + /** @description The organization private registry configuration */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["org-private-registry-configuration-with-selected-repositories"]; + }; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "private-registries/get-org-public-key": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * @description The identifier for the key. + * @example 012345678912345678 + */ + key_id: string; + /** + * @description The Base64 encoded public key. + * @example 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 + */ + key: string; + }; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + "private-registries/get-org-private-registry": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The name of the secret. */ + secret_name: components["parameters"]["secret-name"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description The specified private registry configuration for the organization */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["org-private-registry-configuration"]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + "private-registries/delete-org-private-registry": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The name of the secret. */ + secret_name: components["parameters"]["secret-name"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 400: components["responses"]["bad_request"]; + 404: components["responses"]["not_found"]; + }; + }; + "private-registries/update-org-private-registry": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The name of the secret. */ + secret_name: components["parameters"]["secret-name"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** + * @description The registry type. + * @enum {string} + */ + registry_type?: "maven_repository"; + /** @description The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication. */ + username?: string | null; + /** @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint. */ + encrypted_value?: string; + /** @description The ID of the key you used to encrypt the secret. */ + key_id?: string; + /** + * @description Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry. + * @enum {string} + */ + visibility?: "all" | "private" | "selected"; + /** @description An array of repository IDs that can access the organization private registry. You can only provide a list of repository IDs when `visibility` is set to `selected`. This field should be omitted if `visibility` is set to `all` or `private`. */ + selected_repository_ids?: number[]; + }; + }; + }; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; "projects/list-for-org": { parameters: { query?: { @@ -96672,23 +97969,7 @@ export interface operations { }; requestBody: { content: { - "application/json": { - /** - * @description The type of the value for the property - * @example single_select - * @enum {string} - */ - value_type: "string" | "single_select" | "multi_select" | "true_false"; - /** @description Whether the property is required. */ - required?: boolean; - /** @description Default value of the property */ - default_value?: (string | string[]) | null; - /** @description Short description of the property */ - description?: string | null; - /** @description An ordered list of the allowed values of the property. - * The property can have up to 200 allowed values. */ - allowed_values?: string[] | null; - }; + "application/json": components["schemas"]["custom-property-set-payload"]; }; }; responses: { @@ -97145,7 +98426,7 @@ export interface operations { * @default branch * @enum {string} */ - target?: "branch" | "tag" | "push"; + target?: "branch" | "tag" | "push" | "repository"; enforcement: components["schemas"]["repository-rule-enforcement"]; /** @description The actors that can bypass the rules in this ruleset */ bypass_actors?: components["schemas"]["repository-ruleset-bypass-actor"][]; @@ -97174,7 +98455,7 @@ export interface operations { query?: { /** @description The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. */ ref?: components["parameters"]["ref-in-query"]; - /** @description The name of the repository to filter on. When specified, only rule evaluations from this repository will be returned. */ + /** @description The name of the repository to filter on. */ repository_name?: components["parameters"]["repository-name-in-query"]; /** @description The time period to filter by. * @@ -97290,7 +98571,7 @@ export interface operations { * @description The target of the ruleset * @enum {string} */ - target?: "branch" | "tag" | "push"; + target?: "branch" | "tag" | "push" | "repository"; enforcement?: components["schemas"]["repository-rule-enforcement"]; /** @description The actors that can bypass the rules in this ruleset */ bypass_actors?: components["schemas"]["repository-ruleset-bypass-actor"][]; @@ -97344,9 +98625,7 @@ export interface operations { query?: { /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ state?: components["parameters"]["secret-scanning-alert-state"]; - /** @description A comma-separated list of secret types to return. By default all secret types are returned. - * See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" - * for a complete list of secret types. */ + /** @description A comma-separated list of secret types to return. All default secret patterns are returned. To return experimental patterns, pass the token name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. */ secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ resolution?: components["parameters"]["secret-scanning-alert-resolution"]; @@ -102365,6 +103644,7 @@ export interface operations { }; }; repository_id?: number; + bundle_url?: string; }[]; }; }; @@ -104453,6 +105733,126 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; + "code-scanning/get-autofix": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The account owner of the repository. The name is not case sensitive. */ + owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ + repo: components["parameters"]["repo"]; + /** @description The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */ + alert_number: components["parameters"]["alert-number"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["code-scanning-autofix"]; + }; + }; + 400: components["responses"]["code_scanning_bad_request"]; + 403: components["responses"]["code_scanning_forbidden_read"]; + 404: components["responses"]["not_found"]; + 503: components["responses"]["service_unavailable"]; + }; + }; + "code-scanning/create-autofix": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The account owner of the repository. The name is not case sensitive. */ + owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ + repo: components["parameters"]["repo"]; + /** @description The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */ + alert_number: components["parameters"]["alert-number"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["code-scanning-autofix"]; + }; + }; + /** @description Accepted */ + 202: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["code-scanning-autofix"]; + }; + }; + 400: components["responses"]["code_scanning_bad_request"]; + 403: components["responses"]["code_scanning_autofix_create_forbidden"]; + 404: components["responses"]["not_found"]; + /** @description Unprocessable Entity */ + 422: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 503: components["responses"]["service_unavailable"]; + }; + }; + "code-scanning/commit-autofix": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The account owner of the repository. The name is not case sensitive. */ + owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ + repo: components["parameters"]["repo"]; + /** @description The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */ + alert_number: components["parameters"]["alert-number"]; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": components["schemas"]["code-scanning-autofix-commits"]; + }; + }; + responses: { + /** @description Created */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["code-scanning-autofix-commits-response"]; + }; + }; + 400: components["responses"]["code_scanning_bad_request"]; + 403: components["responses"]["code_scanning_forbidden_write"]; + 404: components["responses"]["not_found"]; + /** @description Unprocessable Entity */ + 422: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 503: components["responses"]["service_unavailable"]; + }; + }; "code-scanning/list-alert-instances": { parameters: { query?: { @@ -110669,6 +112069,163 @@ export interface operations { }; }; }; + "issues/remove-sub-issue": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The account owner of the repository. The name is not case sensitive. */ + owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ + repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ + issue_number: components["parameters"]["issue-number"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description The sub-issue to remove */ + sub_issue_id: number; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + /** @example https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue */ + Location?: string; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["issue"]; + }; + }; + 400: components["responses"]["bad_request"]; + 404: components["responses"]["not_found"]; + }; + }; + "issues/list-sub-issues": { + parameters: { + query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + page?: components["parameters"]["page"]; + }; + header?: never; + path: { + /** @description The account owner of the repository. The name is not case sensitive. */ + owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ + repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ + issue_number: components["parameters"]["issue-number"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["issue"][]; + }; + }; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; + }; + }; + "issues/add-sub-issue": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The account owner of the repository. The name is not case sensitive. */ + owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ + repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ + issue_number: components["parameters"]["issue-number"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description The sub-issue to add */ + sub_issue_id: number; + /** @description Option that, when true, instructs the operation to replace the sub-issues current parent issue */ + replace_parent?: boolean; + }; + }; + }; + responses: { + /** @description Response */ + 201: { + headers: { + /** @example https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1 */ + Location?: string; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["issue"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "issues/reprioritize-sub-issue": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The account owner of the repository. The name is not case sensitive. */ + owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ + repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ + issue_number: components["parameters"]["issue-number"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description The id of the sub-issue to reprioritize */ + sub_issue_id: number; + /** @description The id of the sub-issue to be prioritized after (either positional argument after OR before should be specified). */ + after_id?: number; + /** @description The id of the sub-issue to be prioritized before (either positional argument after OR before should be specified). */ + before_id?: number; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["issue"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed_simple"]; + 503: components["responses"]["service_unavailable"]; + }; + }; "issues/list-events-for-timeline": { parameters: { query?: { @@ -114281,9 +115838,7 @@ export interface operations { query?: { /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ state?: components["parameters"]["secret-scanning-alert-state"]; - /** @description A comma-separated list of secret types to return. By default all secret types are returned. - * See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" - * for a complete list of secret types. */ + /** @description A comma-separated list of secret types to return. All default secret patterns are returned. To return experimental patterns, pass the token name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. */ secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ resolution?: components["parameters"]["secret-scanning-alert-resolution"]; @@ -114524,6 +116079,39 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; + "secret-scanning/get-scan-history": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The account owner of the repository. The name is not case sensitive. */ + owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ + repo: components["parameters"]["repo"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["secret-scanning-scan-history"]; + }; + }; + /** @description Repository does not have GitHub Advanced Security or secret scanning enabled */ + 404: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 503: components["responses"]["service_unavailable"]; + }; + }; "security-advisories/list-repository-advisories": { parameters: { query?: { @@ -120179,6 +121767,7 @@ export interface operations { attestations?: { bundle?: components["schemas"]["sigstore-bundle-0"]; repository_id?: number; + bundle_url?: string; }[]; }; }; diff --git a/packages/openapi-typescript/examples/github-api.ts b/packages/openapi-typescript/examples/github-api.ts index 9906eb7f0..b4eb2bae5 100644 --- a/packages/openapi-typescript/examples/github-api.ts +++ b/packages/openapi-typescript/examples/github-api.ts @@ -289,8 +289,6 @@ export interface paths { * * Optionally, use the `permissions` body parameter to specify the permissions that the installation access token should have. If `permissions` is not specified, the installation access token will have all of the permissions that were granted to the app. The installation access token cannot be granted permissions that the app was not granted. * - * When using the repository or permission parameters to reduce the access of the token, the complexity of the token is increased due to both the number of permissions in the request and the number of repositories the token will have access to. If the complexity is too large, the token will fail to be issued. If this occurs, the error message will indicate the maximum number of repositories that should be requested. For the average application requesting 8 permissions, this limit is around 5000 repositories. With fewer permissions requested, more repositories are supported. - * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ post: operations["apps/create-installation-access-token"]; @@ -602,7 +600,7 @@ export interface paths { patch?: never; trace?: never; }; - "/enterprises/{enterprise}/copilot/billing/seats": { + "/enterprises/{enterprise}/code-security/configurations": { parameters: { query?: never; header?: never; @@ -610,33 +608,31 @@ export interface paths { cookie?: never; }; /** - * List all Copilot seat assignments for an enterprise - * @description > [!NOTE] - * > This endpoint is in public preview and is subject to change. + * Get code security configurations for an enterprise + * @description Lists all code security configurations available in an enterprise. * - * Lists all Copilot seats currently being billed for across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription. + * The authenticated user must be an administrator of the enterprise in order to use this endpoint. * - * Users with access through multiple organizations or enterprise teams will only be counted toward `total_seats` once. - * - * For each organization or enterprise team which grants Copilot access to a user, a seat detail object will appear in the `seats` array. - * Each seat object contains information about the assigned user's most recent Copilot activity. Users must have - * telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. For more information about activity data, - * see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." + * OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. + */ + get: operations["code-security/get-configurations-for-enterprise"]; + put?: never; + /** + * Create a code security configuration for an enterprise + * @description Creates a code security configuration in an enterprise. * - * Only enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams. + * The authenticated user must be an administrator of the enterprise in order to use this endpoint. * - * Personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ - get: operations["copilot/list-copilot-seats-for-enterprise"]; - put?: never; - post?: never; + post: operations["code-security/create-configuration-for-enterprise"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/enterprises/{enterprise}/copilot/metrics": { + "/enterprises/{enterprise}/code-security/configurations/defaults": { parameters: { query?: never; header?: never; @@ -644,19 +640,14 @@ export interface paths { cookie?: never; }; /** - * Get Copilot metrics for an enterprise - * @description Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. - * - * The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, - * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, - * they must have telemetry enabled in their IDE. + * Get default code security configurations for an enterprise + * @description Lists the default code security configurations for an enterprise. * - * To access this endpoint, the Copilot Metrics API access policy must be enabled or set to "no policy" for the enterprise within GitHub settings. - * Only enterprise owners and billing managers can view Copilot metrics for the enterprise. + * The authenticated user must be an administrator of the enterprise in order to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. */ - get: operations["copilot/copilot-metrics-for-enterprise"]; + get: operations["code-security/get-default-configurations-for-enterprise"]; put?: never; post?: never; delete?: never; @@ -665,7 +656,7 @@ export interface paths { patch?: never; trace?: never; }; - "/enterprises/{enterprise}/copilot/usage": { + "/enterprises/{enterprise}/code-security/configurations/{configuration_id}": { parameters: { query?: never; header?: never; @@ -673,52 +664,85 @@ export interface paths { cookie?: never; }; /** - * Get a summary of Copilot usage for enterprise members - * @description > [!NOTE] - * > This endpoint is in public preview and is subject to change. + * Retrieve a code security configuration of an enterprise + * @description Gets a code security configuration available in an enterprise. * - * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE - * for all users across organizations with access to Copilot within your enterprise, with a further breakdown of suggestions, acceptances, - * and number of active users by editor and language for each day. See the response schema tab for detailed metrics definitions. + * The authenticated user must be an administrator of the enterprise in order to use this endpoint. * - * The response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day, - * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, - * they must have telemetry enabled in their IDE. + * OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. + */ + get: operations["code-security/get-single-configuration-for-enterprise"]; + put?: never; + post?: never; + /** + * Delete a code security configuration for an enterprise + * @description Deletes a code security configuration from an enterprise. + * Repositories attached to the configuration will retain their settings but will no longer be associated with + * the configuration. + * + * The authenticated user must be an administrator for the enterprise to use this endpoint. * - * The time zone in the response is in UTC time, that means that the cutoff time for the "day" is UTC time. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + */ + delete: operations["code-security/delete-configuration-for-enterprise"]; + options?: never; + head?: never; + /** + * Update a custom code security configuration for an enterprise + * @description Updates a code security configuration in an enterprise. * - * Only owners and billing managers can view Copilot usage metrics for the enterprise. + * The authenticated user must be an administrator of the enterprise in order to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ - get: operations["copilot/usage-metrics-for-enterprise"]; + patch: operations["code-security/update-enterprise-configuration"]; + trace?: never; + }; + "/enterprises/{enterprise}/code-security/configurations/{configuration_id}/attach": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; put?: never; - post?: never; + /** + * Attach an enterprise configuration to repositories + * @description Attaches an enterprise code security configuration to repositories. If the repositories specified are already attached to a configuration, they will be re-attached to the provided configuration. + * + * If insufficient GHAS licenses are available to attach the configuration to a repository, only free features will be enabled. + * + * The authenticated user must be an administrator for the enterprise to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + */ + post: operations["code-security/attach-enterprise-configuration"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/enterprises/{enterprise}/dependabot/alerts": { + "/enterprises/{enterprise}/code-security/configurations/{configuration_id}/defaults": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; + get?: never; /** - * List Dependabot alerts for an enterprise - * @description Lists Dependabot alerts for repositories that are owned by the specified enterprise. + * Set a code security configuration as a default for an enterprise + * @description Sets a code security configuration as a default to be applied to new repositories in your enterprise. * - * The authenticated user must be a member of the enterprise to use this endpoint. + * This configuration will be applied by default to the matching repository type when created, but only for organizations within the enterprise that do not already have a default code security configuration set. * - * Alerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager. For more information about security managers, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * The authenticated user must be an administrator for the enterprise to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ - get: operations["dependabot/list-alerts-for-enterprise"]; - put?: never; + put: operations["code-security/set-configuration-as-default-for-enterprise"]; post?: never; delete?: never; options?: never; @@ -726,7 +750,7 @@ export interface paths { patch?: never; trace?: never; }; - "/enterprises/{enterprise}/secret-scanning/alerts": { + "/enterprises/{enterprise}/code-security/configurations/{configuration_id}/repositories": { parameters: { query?: never; header?: never; @@ -734,16 +758,14 @@ export interface paths { cookie?: never; }; /** - * List secret scanning alerts for an enterprise - * @description Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest. - * - * Alerts are only returned for organizations in the enterprise for which the authenticated user is an organization owner or a [security manager](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization). + * Get repositories associated with an enterprise code security configuration + * @description Lists the repositories associated with an enterprise code security configuration in an organization. * - * The authenticated user must be a member of the enterprise in order to use this endpoint. + * The authenticated user must be an administrator of the enterprise in order to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope or `security_events` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. */ - get: operations["secret-scanning/list-alerts-for-enterprise"]; + get: operations["code-security/get-repositories-for-enterprise-configuration"]; put?: never; post?: never; delete?: never; @@ -752,7 +774,7 @@ export interface paths { patch?: never; trace?: never; }; - "/enterprises/{enterprise}/team/{team_slug}/copilot/metrics": { + "/enterprises/{enterprise}/dependabot/alerts": { parameters: { query?: never; header?: never; @@ -760,22 +782,16 @@ export interface paths { cookie?: never; }; /** - * Get Copilot metrics for an enterprise team - * @description Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. - * - * The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, - * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, - * they must have telemetry enabled in their IDE. + * List Dependabot alerts for an enterprise + * @description Lists Dependabot alerts for repositories that are owned by the specified enterprise. * - * > [!NOTE] - * > This endpoint will only return results for a given day if the enterprise team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day. + * The authenticated user must be a member of the enterprise to use this endpoint. * - * To access this endpoint, the Copilot Metrics API access policy must be enabled or set to "no policy" for the enterprise within GitHub settings. - * Only owners and billing managers for the enterprise that contains the enterprise team can view Copilot metrics for the enterprise team. + * Alerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager. For more information about security managers, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. */ - get: operations["copilot/copilot-metrics-for-enterprise-team"]; + get: operations["dependabot/list-alerts-for-enterprise"]; put?: never; post?: never; delete?: never; @@ -784,7 +800,7 @@ export interface paths { patch?: never; trace?: never; }; - "/enterprises/{enterprise}/team/{team_slug}/copilot/usage": { + "/enterprises/{enterprise}/secret-scanning/alerts": { parameters: { query?: never; header?: never; @@ -792,26 +808,16 @@ export interface paths { cookie?: never; }; /** - * Get a summary of Copilot usage for an enterprise team - * @description > [!NOTE] - * > This endpoint is in public preview and is subject to change. - * - * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE - * for users within an enterprise team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day. - * See the response schema tab for detailed metrics definitions. - * - * The response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day, - * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, - * they must have telemetry enabled in their IDE. + * List secret scanning alerts for an enterprise + * @description Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest. * - * > [!NOTE] - * > This endpoint will only return results for a given day if the enterprise team had five or more members with active Copilot licenses, as evaluated at the end of that day. + * Alerts are only returned for organizations in the enterprise for which the authenticated user is an organization owner or a [security manager](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization). * - * Owners and billing managers for the enterprise that contains the enterprise team can view Copilot usage metrics for the enterprise team. + * The authenticated user must be a member of the enterprise in order to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope or `security_events` scope to use this endpoint. */ - get: operations["copilot/usage-metrics-for-enterprise-team"]; + get: operations["secret-scanning/list-alerts-for-enterprise"]; put?: never; post?: never; delete?: never; @@ -1637,6 +1643,28 @@ export interface paths { patch?: never; trace?: never; }; + "/organizations/{org}/settings/billing/usage": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get billing usage report for an organization + * @description Gets a report of the total usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account. + * + * **Note:** This endpoint is only available to organizations with access to the enhanced billing platform. For more information, see "[About the enhanced billing platform](https://docs.github.com/billing/using-the-new-billing-platform)." + */ + get: operations["billing/get-github-billing-usage-report-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/orgs/{org}": { parameters: { query?: never; @@ -3217,13 +3245,11 @@ export interface paths { * Purchases a GitHub Copilot seat for all users within each specified team. * The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." * - * Only organization owners can add Copilot seats for their organization members. - * - * In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy. + * Only organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy. * For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." * For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." * - * The response will contain the total number of new seats that were created and existing seats that were refreshed. + * The response contains the total number of new seats that were created and existing seats that were refreshed. * * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. */ @@ -3235,14 +3261,11 @@ export interface paths { * * Sets seats for all members of each team specified to "pending cancellation". * This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team. - * - * For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." - * - * For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." + * For more information about disabling access to Copilot, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." * * Only organization owners can cancel Copilot seats for their organization members. * - * The response will contain the total number of seats set to "pending cancellation". + * The response contains the total number of seats set to "pending cancellation". * * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. */ @@ -3269,13 +3292,11 @@ export interface paths { * Purchases a GitHub Copilot seat for each user specified. * The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." * - * Only organization owners can add Copilot seats for their organization members. - * - * In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy. + * Only organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy. * For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." * For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." * - * The response will contain the total number of new seats that were created and existing seats that were refreshed. + * The response contains the total number of new seats that were created and existing seats that were refreshed. * * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. */ @@ -3287,14 +3308,11 @@ export interface paths { * * Sets seats for all users specified to "pending cancellation". * This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership. - * - * For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." - * - * For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." + * For more information about disabling access to Copilot, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." * * Only organization owners can cancel Copilot seats for their organization members. * - * The response will contain the total number of seats set to "pending cancellation". + * The response contains the total number of seats set to "pending cancellation". * * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. */ @@ -3609,7 +3627,9 @@ export interface paths { }; /** * List organization webhooks - * @description You must be an organization owner to use this endpoint. + * @description List webhooks for an organization. + * + * The authenticated user must be an organization owner to use this endpoint. * * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. @@ -3654,7 +3674,9 @@ export interface paths { post?: never; /** * Delete an organization webhook - * @description You must be an organization owner to use this endpoint. + * @description Delete a webhook for an organization. + * + * The authenticated user must be an organization owner to use this endpoint. * * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. @@ -5027,6 +5049,109 @@ export interface paths { patch?: never; trace?: never; }; + "/orgs/{org}/private-registries": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List private registries for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Lists all private registry configurations available at the organization-level without revealing their encrypted + * values. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + get: operations["private-registries/list-org-private-registries"]; + put?: never; + /** + * Create a private registry for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Creates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + post: operations["private-registries/create-org-private-registry"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/private-registries/public-key": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get private registries public key for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Gets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets. + * + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + get: operations["private-registries/get-org-public-key"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/private-registries/{secret_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get a private registry for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Get the configuration of a single private registry defined for an organization, omitting its encrypted value. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + get: operations["private-registries/get-org-private-registry"]; + put?: never; + post?: never; + /** + * Delete a private registry for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Delete a private registry configuration at the organization-level. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + delete: operations["private-registries/delete-org-private-registry"]; + options?: never; + head?: never; + /** + * Update a private registry for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + patch: operations["private-registries/update-org-private-registry"]; + trace?: never; + }; "/orgs/{org}/projects": { parameters: { query?: never; @@ -5384,11 +5509,9 @@ export interface paths { }; /** * List security manager teams - * @description Lists teams that are security managers for an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." - * - * The authenticated user must be an administrator or security manager for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the "[Organization Roles](https://docs.github.com/rest/orgs/organization-roles)" endpoints instead. */ get: operations["orgs/list-security-manager-teams"]; put?: never; @@ -5409,21 +5532,17 @@ export interface paths { get?: never; /** * Add a security manager team - * @description Adds a team as a security manager for an organization. For more information, see "[Managing security for an organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) for an organization." - * - * The authenticated user must be an administrator for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the "[Organization Roles](https://docs.github.com/rest/orgs/organization-roles)" endpoints instead. */ put: operations["orgs/add-security-manager-team"]; post?: never; /** * Remove a security manager team - * @description Removes the security manager role from a team for an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) team from an organization." - * - * The authenticated user must be an administrator for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the "[Organization Roles](https://docs.github.com/rest/orgs/organization-roles)" endpoints instead. */ delete: operations["orgs/remove-security-manager-team"]; options?: never; @@ -7166,7 +7285,7 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. * - * This API will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`. + * This endpoint will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`. */ get: operations["actions/list-workflow-runs-for-repo"]; put?: never; @@ -7871,6 +7990,8 @@ export interface paths { * Anyone with read access to the repository can use this endpoint * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * + * This endpoint will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`. */ get: operations["actions/list-workflow-runs"]; put?: never; @@ -8806,6 +8927,62 @@ export interface paths { patch: operations["code-scanning/update-alert"]; trace?: never; }; + "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/autofix": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get the status of an autofix for a code scanning alert + * @description Gets the status and description of an autofix for a code scanning alert. + * + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + */ + get: operations["code-scanning/get-autofix"]; + put?: never; + /** + * Create an autofix for a code scanning alert + * @description Creates an autofix for a code scanning alert. + * + * If a new autofix is to be created as a result of this request or is currently being generated, then this endpoint will return a 202 Accepted response. + * + * If an autofix already exists for a given alert, then this endpoint will return a 200 OK response. + * + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + */ + post: operations["code-scanning/create-autofix"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/autofix/commits": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Commit an autofix for a code scanning alert + * @description Commits an autofix for a code scanning alert. + * + * If an autofix is commited as a result of this request, then this endpoint will return a 201 Created response. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + */ + post: operations["code-scanning/commit-autofix"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances": { parameters: { query?: never; @@ -9700,6 +9877,7 @@ export interface paths { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -9842,6 +10020,7 @@ export interface paths { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -10042,6 +10221,7 @@ export interface paths { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -11026,6 +11206,7 @@ export interface paths { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -11075,6 +11256,7 @@ export interface paths { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -11220,6 +11402,7 @@ export interface paths { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -11265,6 +11448,7 @@ export interface paths { * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | * | `signature` | `string` | The signature that was extracted from the commit. | * | `payload` | `string` | The value that was signed. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -11381,7 +11565,12 @@ export interface paths { get: operations["repos/get-webhook"]; put?: never; post?: never; - /** Delete a repository webhook */ + /** + * Delete a repository webhook + * @description Delete a webhook for an organization. + * + * The authenticated user must be a repository owner, or have admin access in the repository, to delete the webhook. + */ delete: operations["repos/delete-webhook"]; options?: never; head?: never; @@ -12288,6 +12477,96 @@ export interface paths { patch?: never; trace?: never; }; + "/repos/{owner}/{repo}/issues/{issue_number}/sub_issue": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + /** + * Remove sub-issue + * @description You can use the REST API to remove a sub-issue from an issue. + * Removing content too quickly using this endpoint may result in secondary rate limiting. + * For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass a specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + */ + delete: operations["issues/remove-sub-issue"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/issues/{issue_number}/sub_issues": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List sub-issues + * @description You can use the REST API to list the sub-issues on an issue. + * + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + */ + get: operations["issues/list-sub-issues"]; + put?: never; + /** + * Add sub-issue + * @description You can use the REST API to add sub-issues to issues. + * + * Creating content too quickly using this endpoint may result in secondary rate limiting. + * For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + * + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + */ + post: operations["issues/add-sub-issue"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/issues/{issue_number}/sub_issues/priority": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + /** + * Reprioritize sub-issue + * @description You can use the REST API to reprioritize a sub-issue to a different position in the parent list. + */ + patch: operations["issues/reprioritize-sub-issue"]; + trace?: never; + }; "/repos/{owner}/{repo}/issues/{issue_number}/timeline": { parameters: { query?: never; @@ -13586,7 +13865,13 @@ export interface paths { }; /** * Get a release asset - * @description To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response. + * @description To download the asset's binary content: + * + * - If within a browser, fetch the location specified in the `browser_download_url` key provided in the response. + * - Alternatively, set the `Accept` header of the request to + * [`application/octet-stream`](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + * The API will either redirect the client to the location, or stream it directly if possible. + * API clients should handle both a `200` or `302` response. */ get: operations["repos/get-release-asset"]; put?: never; @@ -14005,6 +14290,28 @@ export interface paths { patch?: never; trace?: never; }; + "/repos/{owner}/{repo}/secret-scanning/scan-history": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get secret scanning scan history for a repository + * @description Lists the latest incremental and backfill scans by type for a repository. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + */ + get: operations["secret-scanning/get-scan-history"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/repos/{owner}/{repo}/security-advisories": { parameters: { query?: never; @@ -19792,394 +20099,396 @@ export interface components { /** Format: uri */ html_url: string | null; }; - /** - * Organization Simple - * @description A GitHub organization. - */ - "nullable-organization-simple": { - /** @example github */ - login: string; - /** @example 1 */ - id: number; - /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ - node_id: string; + /** @description A code security configuration */ + "code-security-configuration": { + /** @description The ID of the code security configuration */ + id?: number; + /** @description The name of the code security configuration. Must be unique within the organization. */ + name?: string; /** - * Format: uri - * @example https://api.github.com/orgs/github + * @description The type of the code security configuration. + * @enum {string} */ - url: string; + target_type?: "global" | "organization" | "enterprise"; + /** @description A description of the code security configuration */ + description?: string; + /** + * @description The enablement status of GitHub Advanced Security + * @enum {string} + */ + advanced_security?: "enabled" | "disabled"; + /** + * @description The enablement status of Dependency Graph + * @enum {string} + */ + dependency_graph?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Automatic dependency submission + * @enum {string} + */ + dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for Automatic dependency submission */ + dependency_graph_autosubmit_action_options?: { + /** @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. */ + labeled_runners?: boolean; + }; + /** + * @description The enablement status of Dependabot alerts + * @enum {string} + */ + dependabot_alerts?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot security updates + * @enum {string} + */ + dependabot_security_updates?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of code scanning default setup + * @enum {string} + */ + code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for code scanning default setup */ + code_scanning_default_setup_options?: { + /** + * @description Whether to use labeled runners or standard GitHub runners. + * @enum {string|null} + */ + runner_type?: "standard" | "labeled" | "not_set" | null; + /** @description The label of the runner to use for code scanning when runner_type is 'labeled'. */ + runner_label?: string | null; + } | null; + /** + * @description The enablement status of secret scanning + * @enum {string} + */ + secret_scanning?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning push protection + * @enum {string} + */ + secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning delegated bypass + * @enum {string} + */ + secret_scanning_delegated_bypass?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for secret scanning delegated bypass */ + secret_scanning_delegated_bypass_options?: { + /** @description The bypass reviewers for secret scanning delegated bypass */ + reviewers?: { + /** @description The ID of the team or role selected as a bypass reviewer */ + reviewer_id: number; + /** + * @description The type of the bypass reviewer + * @enum {string} + */ + reviewer_type: "TEAM" | "ROLE"; + }[]; + }; + /** + * @description The enablement status of secret scanning validity checks + * @enum {string} + */ + secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning non-provider patterns + * @enum {string} + */ + secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of private vulnerability reporting + * @enum {string} + */ + private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; + /** + * @description The enforcement status for a security configuration + * @enum {string} + */ + enforcement?: "enforced" | "unenforced"; /** * Format: uri - * @example https://api.github.com/orgs/github/repos + * @description The URL of the configuration */ - repos_url: string; + url?: string; /** * Format: uri - * @example https://api.github.com/orgs/github/events + * @description The URL of the configuration */ - events_url: string; - /** @example https://api.github.com/orgs/github/hooks */ - hooks_url: string; - /** @example https://api.github.com/orgs/github/issues */ - issues_url: string; - /** @example https://api.github.com/orgs/github/members{/member} */ - members_url: string; - /** @example https://api.github.com/orgs/github/public_members{/member} */ - public_members_url: string; - /** @example https://github.com/images/error/octocat_happy.gif */ - avatar_url: string; - /** @example A great organization */ - description: string | null; + html_url?: string; + /** Format: date-time */ + created_at?: string; + /** Format: date-time */ + updated_at?: string; + }; + /** @description Feature options for code scanning default setup */ + "code-scanning-default-setup-options": { + /** + * @description Whether to use labeled runners or standard GitHub runners. + * @enum {string} + */ + runner_type?: "standard" | "labeled" | "not_set"; + /** @description The label of the runner to use for code scanning default setup when runner_type is 'labeled'. */ + runner_label?: string | null; } | null; + /** @description A list of default code security configurations */ + "code-security-default-configurations": { + /** + * @description The visibility of newly created repositories for which the code security configuration will be applied to by default + * @enum {unknown} + */ + default_for_new_repos?: "public" | "private_and_internal" | "all"; + configuration?: components["schemas"]["code-security-configuration"]; + }[]; /** - * Team Simple - * @description Groups of organization members that gives permissions on specified repositories. + * Simple Repository + * @description A GitHub repository. */ - "nullable-team-simple": { + "simple-repository": { /** - * @description Unique identifier of the team - * @example 1 + * Format: int64 + * @description A unique identifier of the repository. + * @example 1296269 */ id: number; - /** @example MDQ6VGVhbTE= */ + /** + * @description The GraphQL identifier of the repository. + * @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + */ node_id: string; + /** + * @description The name of the repository. + * @example Hello-World + */ + name: string; + /** + * @description The full, globally unique, name of the repository. + * @example octocat/Hello-World + */ + full_name: string; + owner: components["schemas"]["simple-user"]; + /** @description Whether the repository is private. */ + private: boolean; /** * Format: uri - * @description URL for the team - * @example https://api.github.com/organizations/1/team/1 + * @description The URL to view the repository on GitHub.com. + * @example https://github.com/octocat/Hello-World + */ + html_url: string; + /** + * @description The repository description. + * @example This your first repo! + */ + description: string | null; + /** @description Whether the repository is a fork. */ + fork: boolean; + /** + * Format: uri + * @description The URL to get more information about the repository from the GitHub API. + * @example https://api.github.com/repos/octocat/Hello-World */ url: string; - /** @example https://api.github.com/organizations/1/team/1/members{/member} */ - members_url: string; /** - * @description Name of the team - * @example Justice League + * @description A template for the API URL to download the repository as an archive. + * @example https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ - name: string; + archive_url: string; /** - * @description Description of the team - * @example A great team. + * @description A template for the API URL to list the available assignees for issues in the repository. + * @example https://api.github.com/repos/octocat/Hello-World/assignees{/user} */ - description: string | null; + assignees_url: string; /** - * @description Permission that the team will have for its repositories - * @example admin + * @description A template for the API URL to create or retrieve a raw Git blob in the repository. + * @example https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} */ - permission: string; + blobs_url: string; /** - * @description The level of privacy this team should have - * @example closed + * @description A template for the API URL to get information about branches in the repository. + * @example https://api.github.com/repos/octocat/Hello-World/branches{/branch} */ - privacy?: string; + branches_url: string; /** - * @description The notification setting the team has set - * @example notifications_enabled + * @description A template for the API URL to get information about collaborators of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} */ - notification_setting?: string; + collaborators_url: string; + /** + * @description A template for the API URL to get information about comments on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/comments{/number} + */ + comments_url: string; + /** + * @description A template for the API URL to get information about commits on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/commits{/sha} + */ + commits_url: string; + /** + * @description A template for the API URL to compare two commits or refs. + * @example https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + */ + compare_url: string; + /** + * @description A template for the API URL to get the contents of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/contents/{+path} + */ + contents_url: string; /** * Format: uri - * @example https://github.com/orgs/rails/teams/core + * @description A template for the API URL to list the contributors to the repository. + * @example https://api.github.com/repos/octocat/Hello-World/contributors */ - html_url: string; + contributors_url: string; /** * Format: uri - * @example https://api.github.com/organizations/1/team/1/repos + * @description The API URL to list the deployments of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/deployments */ - repositories_url: string; - /** @example justice-league */ - slug: string; + deployments_url: string; /** - * @description Distinguished Name (DN) that team maps to within LDAP environment - * @example uid=example,ou=users,dc=github,dc=com + * Format: uri + * @description The API URL to list the downloads on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/downloads */ - ldap_dn?: string; - } | null; - /** - * Team - * @description Groups of organization members that gives permissions on specified repositories. - */ - team: { - id: number; - node_id: string; - name: string; - slug: string; - description: string | null; - privacy?: string; - notification_setting?: string; - permission: string; - permissions?: { - pull: boolean; - triage: boolean; - push: boolean; - maintain: boolean; - admin: boolean; - }; - /** Format: uri */ - url: string; + downloads_url: string; /** * Format: uri - * @example https://github.com/orgs/rails/teams/core + * @description The API URL to list the events of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/events */ - html_url: string; - members_url: string; - /** Format: uri */ - repositories_url: string; - parent: components["schemas"]["nullable-team-simple"]; - }; - /** - * Enterprise Team - * @description Group of enterprise owners and/or members - */ - "enterprise-team": { - /** Format: int64 */ - id: number; - name: string; - slug: string; - /** Format: uri */ - url: string; - /** @example disabled | all */ - sync_to_organizations: string; - /** @example 62ab9291-fae2-468e-974b-7e45096d5021 */ - group_id?: string | null; + events_url: string; /** * Format: uri - * @example https://github.com/enterprises/dc/teams/justice-league + * @description The API URL to list the forks of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/forks */ - html_url: string; - members_url: string; - /** Format: date-time */ - created_at: string; - /** Format: date-time */ - updated_at: string; - }; - /** - * Copilot Business Seat Detail - * @description Information about a Copilot Business seat assignment for a user, team, or organization. - */ - "copilot-seat-details": { - assignee: components["schemas"]["simple-user"]; - organization?: components["schemas"]["nullable-organization-simple"]; - /** @description The team through which the assignee is granted access to GitHub Copilot, if applicable. */ - assigning_team?: (components["schemas"]["team"] | components["schemas"]["enterprise-team"]) | null; + forks_url: string; /** - * Format: date - * @description The pending cancellation date for the seat, in `YYYY-MM-DD` format. This will be null unless the assignee's Copilot access has been canceled during the current billing cycle. If the seat has been cancelled, this corresponds to the start of the organization's next billing cycle. + * @description A template for the API URL to get information about Git commits of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ - pending_cancellation_date?: string | null; + git_commits_url: string; /** - * Format: date-time - * @description Timestamp of user's last GitHub Copilot activity, in ISO 8601 format. + * @description A template for the API URL to get information about Git refs of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} */ - last_activity_at?: string | null; - /** @description Last editor that was used by the user for a GitHub Copilot completion. */ - last_activity_editor?: string | null; + git_refs_url: string; /** - * Format: date-time - * @description Timestamp of when the assignee was last granted access to GitHub Copilot, in ISO 8601 format. + * @description A template for the API URL to get information about Git tags of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} */ - created_at: string; + git_tags_url: string; /** - * Format: date-time - * @description Timestamp of when the assignee's GitHub Copilot access was last updated, in ISO 8601 format. + * @description A template for the API URL to get information about issue comments on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} */ - updated_at?: string; + issue_comment_url: string; /** - * @description The Copilot plan of the organization, or the parent enterprise, when applicable. - * @enum {string} + * @description A template for the API URL to get information about issue events on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/issues/events{/number} */ - plan_type?: "business" | "enterprise" | "unknown"; - }; - /** @description Usage metrics for Copilot editor code completions in the IDE. */ - "copilot-ide-code-completions": ({ - /** @description Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances. */ - total_engaged_users?: number; - /** @description Code completion metrics for active languages. */ - languages?: { - /** @description Name of the language used for Copilot code completion suggestions. */ - name?: string; - /** @description Number of users who accepted at least one Copilot code completion suggestion for the given language. Includes both full and partial acceptances. */ - total_engaged_users?: number; - }[]; - editors?: ({ - /** @description Name of the given editor. */ - name?: string; - /** @description Number of users who accepted at least one Copilot code completion suggestion for the given editor. Includes both full and partial acceptances. */ - total_engaged_users?: number; - /** @description List of model metrics for custom models and the default model. */ - models?: { - /** @description Name of the language used for Copilot code completion suggestions, for the given editor. */ - name?: string; - /** @description Indicates whether a model is custom or default. */ - is_custom_model?: boolean; - /** @description The training date for the custom model. */ - custom_model_training_date?: string | null; - /** @description Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances. */ - total_engaged_users?: number; - /** @description Code completion metrics for active languages, for the given editor. */ - languages?: { - /** @description Name of the language used for Copilot code completion suggestions, for the given editor. */ - name?: string; - /** @description Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language. Includes both full and partial acceptances. */ - total_engaged_users?: number; - /** @description The number of Copilot code suggestions generated for the given editor, for the given language. */ - total_code_suggestions?: number; - /** @description The number of Copilot code suggestions accepted for the given editor, for the given language. Includes both full and partial acceptances. */ - total_code_acceptances?: number; - /** @description The number of lines of code suggested by Copilot code completions for the given editor, for the given language. */ - total_code_lines_suggested?: number; - /** @description The number of lines of code accepted from Copilot code suggestions for the given editor, for the given language. */ - total_code_lines_accepted?: number; - }[]; - }[]; - } & { - [key: string]: unknown; - })[]; - } & { - [key: string]: unknown; - }) | null; - /** @description Usage metrics for Copilot Chat in the IDE. */ - "copilot-ide-chat": ({ - /** @description Total number of users who prompted Copilot Chat in the IDE. */ - total_engaged_users?: number; - editors?: { - /** @description Name of the given editor. */ - name?: string; - /** @description The number of users who prompted Copilot Chat in the specified editor. */ - total_engaged_users?: number; - /** @description List of model metrics for custom models and the default model. */ - models?: { - /** @description Name of the language used for Copilot code completion suggestions, for the given editor. */ - name?: string; - /** @description Indicates whether a model is custom or default. */ - is_custom_model?: boolean; - /** @description The training date for the custom model. */ - custom_model_training_date?: string | null; - /** @description The number of users who prompted Copilot Chat in the given editor and model. */ - total_engaged_users?: number; - /** @description The total number of chats initiated by users in the given editor and model. */ - total_chats?: number; - /** @description The number of times users accepted a code suggestion from Copilot Chat using the 'Insert Code' UI element, for the given editor. */ - total_chat_insertion_events?: number; - /** @description The number of times users copied a code suggestion from Copilot Chat using the keyboard, or the 'Copy' UI element, for the given editor. */ - total_chat_copy_events?: number; - }[]; - }[]; - } & { - [key: string]: unknown; - }) | null; - /** @description Usage metrics for Copilot Chat in github.com */ - "copilot-dotcom-chat": ({ - /** @description Total number of users who prompted Copilot Chat on github.com at least once. */ - total_engaged_users?: number; - /** @description List of model metrics for a custom models and the default model. */ - models?: { - /** @description Name of the language used for Copilot code completion suggestions, for the given editor. */ - name?: string; - /** @description Indicates whether a model is custom or default. */ - is_custom_model?: boolean; - /** @description The training date for the custom model (if applicable). */ - custom_model_training_date?: string | null; - /** @description Total number of users who prompted Copilot Chat on github.com at least once for each model. */ - total_engaged_users?: number; - /** @description Total number of chats initiated by users on github.com. */ - total_chats?: number; - }[]; - } & { - [key: string]: unknown; - }) | null; - /** @description Usage metrics for Copilot for pull requests. */ - "copilot-dotcom-pull-requests": ({ - /** @description The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once. */ - total_engaged_users?: number; - /** @description Repositories in which users used Copilot for Pull Requests to generate pull request summaries */ - repositories?: { - /** @description Repository name */ - name?: string; - /** @description The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository. */ - total_engaged_users?: number; - /** @description List of model metrics for custom models and the default model. */ - models?: { - /** @description Name of the language used for Copilot code completion suggestions, for the given editor. */ - name?: string; - /** @description Indicates whether a model is custom or default. */ - is_custom_model?: boolean; - /** @description The training date for the custom model. */ - custom_model_training_date?: string | null; - /** @description The number of pull request summaries generated using Copilot for Pull Requests in the given repository. */ - total_pr_summaries_created?: number; - /** @description The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository and model. */ - total_engaged_users?: number; - }[]; - }[]; - } & { - [key: string]: unknown; - }) | null; - /** - * Copilot Usage Metrics - * @description Copilot usage metrics for a given day. - */ - "copilot-usage-metrics-day": { + issue_events_url: string; /** - * Format: date - * @description The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format. + * @description A template for the API URL to get information about issues on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/issues{/number} */ - date: string; - /** @description The total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint. */ - total_active_users?: number; - /** @description The total number of Copilot users who engaged with any Copilot feature, for the given day. Examples include but are not limited to accepting a code suggestion, prompting Copilot chat, or triggering a PR Summary. Does not include authentication events. Is not limited to the individual features detailed on the endpoint. */ - total_engaged_users?: number; - copilot_ide_code_completions?: components["schemas"]["copilot-ide-code-completions"]; - copilot_ide_chat?: components["schemas"]["copilot-ide-chat"]; - copilot_dotcom_chat?: components["schemas"]["copilot-dotcom-chat"]; - copilot_dotcom_pull_requests?: components["schemas"]["copilot-dotcom-pull-requests"]; - } & { - [key: string]: unknown; + issues_url: string; + /** + * @description A template for the API URL to get information about deploy keys on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + */ + keys_url: string; + /** + * @description A template for the API URL to get information about labels of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/labels{/name} + */ + labels_url: string; + /** + * Format: uri + * @description The API URL to get information about the languages of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/languages + */ + languages_url: string; + /** + * Format: uri + * @description The API URL to merge branches in the repository. + * @example https://api.github.com/repos/octocat/Hello-World/merges + */ + merges_url: string; + /** + * @description A template for the API URL to get information about milestones of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/milestones{/number} + */ + milestones_url: string; + /** + * @description A template for the API URL to get information about notifications on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + */ + notifications_url: string; + /** + * @description A template for the API URL to get information about pull requests on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/pulls{/number} + */ + pulls_url: string; + /** + * @description A template for the API URL to get information about releases on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/releases{/id} + */ + releases_url: string; + /** + * Format: uri + * @description The API URL to list the stargazers on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/stargazers + */ + stargazers_url: string; + /** + * @description A template for the API URL to get information about statuses of a commit. + * @example https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + */ + statuses_url: string; + /** + * Format: uri + * @description The API URL to list the subscribers on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/subscribers + */ + subscribers_url: string; + /** + * Format: uri + * @description The API URL to subscribe to notifications for this repository. + * @example https://api.github.com/repos/octocat/Hello-World/subscription + */ + subscription_url: string; + /** + * Format: uri + * @description The API URL to get information about tags on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/tags + */ + tags_url: string; + /** + * Format: uri + * @description The API URL to list the teams on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/teams + */ + teams_url: string; + /** + * @description A template for the API URL to create or retrieve a raw Git tree of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + */ + trees_url: string; + /** + * Format: uri + * @description The API URL to list the hooks on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/hooks + */ + hooks_url: string; }; - /** - * Copilot Usage Metrics - * @description Summary of Copilot usage. - */ - "copilot-usage-metrics": { + /** @description Repositories associated with a code security configuration and attachment status */ + "code-security-configuration-repositories": { /** - * Format: date - * @description The date for which the usage metrics are reported, in `YYYY-MM-DD` format. + * @description The attachment status of the code security configuration on the repository. + * @enum {string} */ - day: string; - /** @description The total number of Copilot code completion suggestions shown to users. */ - total_suggestions_count?: number; - /** @description The total number of Copilot code completion suggestions accepted by users. */ - total_acceptances_count?: number; - /** @description The total number of lines of code completions suggested by Copilot. */ - total_lines_suggested?: number; - /** @description The total number of lines of code completions accepted by users. */ - total_lines_accepted?: number; - /** @description The total number of users who were shown Copilot code completion suggestions during the day specified. */ - total_active_users?: number; - /** @description The total instances of users who accepted code suggested by Copilot Chat in the IDE (panel and inline). */ - total_chat_acceptances?: number; - /** @description The total number of chat turns (prompt and response pairs) sent between users and Copilot Chat in the IDE. */ - total_chat_turns?: number; - /** @description The total number of users who interacted with Copilot Chat in the IDE during the day specified. */ - total_active_chat_users?: number; - /** @description Breakdown of Copilot code completions usage by language and editor */ - breakdown: ({ - /** @description The language in which Copilot suggestions were shown to users in the specified editor. */ - language?: string; - /** @description The editor in which Copilot suggestions were shown to users for the specified language. */ - editor?: string; - /** @description The number of Copilot suggestions shown to users in the editor specified during the day specified. */ - suggestions_count?: number; - /** @description The number of Copilot suggestions accepted by users in the editor specified during the day specified. */ - acceptances_count?: number; - /** @description The number of lines of code suggested by Copilot in the editor specified during the day specified. */ - lines_suggested?: number; - /** @description The number of lines of code accepted by users in the editor specified during the day specified. */ - lines_accepted?: number; - /** @description The number of users who were shown Copilot completion suggestions in the editor specified during the day specified. */ - active_users?: number; - } & { - [key: string]: unknown; - })[] | null; + status?: "attached" | "attaching" | "detached" | "removed" | "enforced" | "failed" | "updating" | "removed_by_enterprise"; + repository?: components["schemas"]["simple-repository"]; }; /** @description The security alert number. */ "alert-number": number; @@ -20307,248 +20616,6 @@ export interface components { * @description The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ "alert-auto-dismissed-at": string | null; - /** - * Simple Repository - * @description A GitHub repository. - */ - "simple-repository": { - /** - * Format: int64 - * @description A unique identifier of the repository. - * @example 1296269 - */ - id: number; - /** - * @description The GraphQL identifier of the repository. - * @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - */ - node_id: string; - /** - * @description The name of the repository. - * @example Hello-World - */ - name: string; - /** - * @description The full, globally unique, name of the repository. - * @example octocat/Hello-World - */ - full_name: string; - owner: components["schemas"]["simple-user"]; - /** @description Whether the repository is private. */ - private: boolean; - /** - * Format: uri - * @description The URL to view the repository on GitHub.com. - * @example https://github.com/octocat/Hello-World - */ - html_url: string; - /** - * @description The repository description. - * @example This your first repo! - */ - description: string | null; - /** @description Whether the repository is a fork. */ - fork: boolean; - /** - * Format: uri - * @description The URL to get more information about the repository from the GitHub API. - * @example https://api.github.com/repos/octocat/Hello-World - */ - url: string; - /** - * @description A template for the API URL to download the repository as an archive. - * @example https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - */ - archive_url: string; - /** - * @description A template for the API URL to list the available assignees for issues in the repository. - * @example https://api.github.com/repos/octocat/Hello-World/assignees{/user} - */ - assignees_url: string; - /** - * @description A template for the API URL to create or retrieve a raw Git blob in the repository. - * @example https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - */ - blobs_url: string; - /** - * @description A template for the API URL to get information about branches in the repository. - * @example https://api.github.com/repos/octocat/Hello-World/branches{/branch} - */ - branches_url: string; - /** - * @description A template for the API URL to get information about collaborators of the repository. - * @example https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - */ - collaborators_url: string; - /** - * @description A template for the API URL to get information about comments on the repository. - * @example https://api.github.com/repos/octocat/Hello-World/comments{/number} - */ - comments_url: string; - /** - * @description A template for the API URL to get information about commits on the repository. - * @example https://api.github.com/repos/octocat/Hello-World/commits{/sha} - */ - commits_url: string; - /** - * @description A template for the API URL to compare two commits or refs. - * @example https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - */ - compare_url: string; - /** - * @description A template for the API URL to get the contents of the repository. - * @example https://api.github.com/repos/octocat/Hello-World/contents/{+path} - */ - contents_url: string; - /** - * Format: uri - * @description A template for the API URL to list the contributors to the repository. - * @example https://api.github.com/repos/octocat/Hello-World/contributors - */ - contributors_url: string; - /** - * Format: uri - * @description The API URL to list the deployments of the repository. - * @example https://api.github.com/repos/octocat/Hello-World/deployments - */ - deployments_url: string; - /** - * Format: uri - * @description The API URL to list the downloads on the repository. - * @example https://api.github.com/repos/octocat/Hello-World/downloads - */ - downloads_url: string; - /** - * Format: uri - * @description The API URL to list the events of the repository. - * @example https://api.github.com/repos/octocat/Hello-World/events - */ - events_url: string; - /** - * Format: uri - * @description The API URL to list the forks of the repository. - * @example https://api.github.com/repos/octocat/Hello-World/forks - */ - forks_url: string; - /** - * @description A template for the API URL to get information about Git commits of the repository. - * @example https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - */ - git_commits_url: string; - /** - * @description A template for the API URL to get information about Git refs of the repository. - * @example https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - */ - git_refs_url: string; - /** - * @description A template for the API URL to get information about Git tags of the repository. - * @example https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - */ - git_tags_url: string; - /** - * @description A template for the API URL to get information about issue comments on the repository. - * @example https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - */ - issue_comment_url: string; - /** - * @description A template for the API URL to get information about issue events on the repository. - * @example https://api.github.com/repos/octocat/Hello-World/issues/events{/number} - */ - issue_events_url: string; - /** - * @description A template for the API URL to get information about issues on the repository. - * @example https://api.github.com/repos/octocat/Hello-World/issues{/number} - */ - issues_url: string; - /** - * @description A template for the API URL to get information about deploy keys on the repository. - * @example https://api.github.com/repos/octocat/Hello-World/keys{/key_id} - */ - keys_url: string; - /** - * @description A template for the API URL to get information about labels of the repository. - * @example https://api.github.com/repos/octocat/Hello-World/labels{/name} - */ - labels_url: string; - /** - * Format: uri - * @description The API URL to get information about the languages of the repository. - * @example https://api.github.com/repos/octocat/Hello-World/languages - */ - languages_url: string; - /** - * Format: uri - * @description The API URL to merge branches in the repository. - * @example https://api.github.com/repos/octocat/Hello-World/merges - */ - merges_url: string; - /** - * @description A template for the API URL to get information about milestones of the repository. - * @example https://api.github.com/repos/octocat/Hello-World/milestones{/number} - */ - milestones_url: string; - /** - * @description A template for the API URL to get information about notifications on the repository. - * @example https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - */ - notifications_url: string; - /** - * @description A template for the API URL to get information about pull requests on the repository. - * @example https://api.github.com/repos/octocat/Hello-World/pulls{/number} - */ - pulls_url: string; - /** - * @description A template for the API URL to get information about releases on the repository. - * @example https://api.github.com/repos/octocat/Hello-World/releases{/id} - */ - releases_url: string; - /** - * Format: uri - * @description The API URL to list the stargazers on the repository. - * @example https://api.github.com/repos/octocat/Hello-World/stargazers - */ - stargazers_url: string; - /** - * @description A template for the API URL to get information about statuses of a commit. - * @example https://api.github.com/repos/octocat/Hello-World/statuses/{sha} - */ - statuses_url: string; - /** - * Format: uri - * @description The API URL to list the subscribers on the repository. - * @example https://api.github.com/repos/octocat/Hello-World/subscribers - */ - subscribers_url: string; - /** - * Format: uri - * @description The API URL to subscribe to notifications for this repository. - * @example https://api.github.com/repos/octocat/Hello-World/subscription - */ - subscription_url: string; - /** - * Format: uri - * @description The API URL to get information about tags on the repository. - * @example https://api.github.com/repos/octocat/Hello-World/tags - */ - tags_url: string; - /** - * Format: uri - * @description The API URL to list the teams on the repository. - * @example https://api.github.com/repos/octocat/Hello-World/teams - */ - teams_url: string; - /** - * @description A template for the API URL to create or retrieve a raw Git tree of the repository. - * @example https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - */ - trees_url: string; - /** - * Format: uri - * @description The API URL to list the hooks on the repository. - * @example https://api.github.com/repos/octocat/Hello-World/hooks - */ - hooks_url: string; - }; /** @description A Dependabot alert. */ "dependabot-alert-with-repository": { number: components["schemas"]["alert-number"]; @@ -20637,6 +20704,16 @@ export interface components { * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ push_protection_bypassed_at?: string | null; + push_protection_bypass_request_reviewer?: components["schemas"]["nullable-simple-user"]; + /** @description An optional comment when reviewing a push protection bypass. */ + push_protection_bypass_request_reviewer_comment?: string | null; + /** @description An optional comment when requesting a push protection bypass. */ + push_protection_bypass_request_comment?: string | null; + /** + * Format: uri + * @description The URL to a push protection bypass request. + */ + push_protection_bypass_request_html_url?: string | null; /** @description The comment that was optionally added when this alert was closed */ resolution_comment?: string | null; /** @@ -20836,6 +20913,12 @@ export interface components { eyes: number; rocket: number; }; + /** Sub-issues Summary */ + "sub-issues-summary": { + total: number; + completed: number; + percent_completed: number; + }; /** * Issue * @description Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. @@ -20938,6 +21021,7 @@ export interface components { performed_via_github_app?: components["schemas"]["nullable-integration"]; author_association: components["schemas"]["author-association"]; reactions?: components["schemas"]["reaction-rollup"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; }; /** * Issue Comment @@ -21624,6 +21708,10 @@ export interface components { copilot?: string[]; packages?: string[]; actions?: string[]; + actions_inbound?: { + full_domains?: string[]; + wildcard_domains?: string[]; + }; artifact_attestations?: { /** @example [ * "example" @@ -21967,6 +22055,32 @@ export interface components { /** @example A great organization */ description: string | null; }; + "billing-usage-report": { + usageItems?: { + /** @description Date of the usage line item. */ + date: string; + /** @description Product name. */ + product: string; + /** @description SKU name. */ + sku: string; + /** @description Quantity of the usage line item. */ + quantity: number; + /** @description Unit type of the usage line item. */ + unitType: string; + /** @description Price per unit of the usage line item. */ + pricePerUnit: number; + /** @description Gross amount of the usage line item. */ + grossAmount: number; + /** @description Discount amount of the usage line item. */ + discountAmount: number; + /** @description Net amount of the usage line item. */ + netAmount: number; + /** @description Name of the organization. */ + organizationName: string; + /** @description Name of the repository. */ + repositoryName?: string; + }[]; + }; /** * Organization Full * @description Organization Full @@ -22588,135 +22702,6 @@ export interface components { most_recent_instance: components["schemas"]["code-scanning-alert-instance"]; repository: components["schemas"]["simple-repository"]; }; - /** @description A code security configuration */ - "code-security-configuration": { - /** @description The ID of the code security configuration */ - id?: number; - /** @description The name of the code security configuration. Must be unique within the organization. */ - name?: string; - /** - * @description The type of the code security configuration. - * @enum {string} - */ - target_type?: "global" | "organization" | "enterprise"; - /** @description A description of the code security configuration */ - description?: string; - /** - * @description The enablement status of GitHub Advanced Security - * @enum {string} - */ - advanced_security?: "enabled" | "disabled"; - /** - * @description The enablement status of Dependency Graph - * @enum {string} - */ - dependency_graph?: "enabled" | "disabled" | "not_set"; - /** - * @description The enablement status of Automatic dependency submission - * @enum {string} - */ - dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"; - /** @description Feature options for Automatic dependency submission */ - dependency_graph_autosubmit_action_options?: { - /** @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. */ - labeled_runners?: boolean; - }; - /** - * @description The enablement status of Dependabot alerts - * @enum {string} - */ - dependabot_alerts?: "enabled" | "disabled" | "not_set"; - /** - * @description The enablement status of Dependabot security updates - * @enum {string} - */ - dependabot_security_updates?: "enabled" | "disabled" | "not_set"; - /** - * @description The enablement status of code scanning default setup - * @enum {string} - */ - code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; - /** - * @description The enablement status of secret scanning - * @enum {string} - */ - secret_scanning?: "enabled" | "disabled" | "not_set"; - /** - * @description The enablement status of secret scanning push protection - * @enum {string} - */ - secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; - /** - * @description The enablement status of secret scanning delegated bypass - * @enum {string} - */ - secret_scanning_delegated_bypass?: "enabled" | "disabled" | "not_set"; - /** @description Feature options for secret scanning delegated bypass */ - secret_scanning_delegated_bypass_options?: { - /** @description The bypass reviewers for secret scanning delegated bypass */ - reviewers?: { - /** @description The ID of the team or role selected as a bypass reviewer */ - reviewer_id: number; - /** - * @description The type of the bypass reviewer - * @enum {string} - */ - reviewer_type: "TEAM" | "ROLE"; - }[]; - }; - /** - * @description The enablement status of secret scanning validity checks - * @enum {string} - */ - secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; - /** - * @description The enablement status of secret scanning non-provider patterns - * @enum {string} - */ - secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set"; - /** - * @description The enablement status of private vulnerability reporting - * @enum {string} - */ - private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; - /** - * @description The enforcement status for a security configuration - * @enum {string} - */ - enforcement?: "enforced" | "unenforced"; - /** - * Format: uri - * @description The URL of the configuration - */ - url?: string; - /** - * Format: uri - * @description The URL of the configuration - */ - html_url?: string; - /** Format: date-time */ - created_at?: string; - /** Format: date-time */ - updated_at?: string; - }; - /** @description A list of default code security configurations */ - "code-security-default-configurations": { - /** - * @description The visibility of newly created repositories for which the code security configuration will be applied to by default - * @enum {unknown} - */ - default_for_new_repos?: "public" | "private_and_internal" | "all"; - configuration?: components["schemas"]["code-security-configuration"]; - }[]; - /** @description Repositories associated with a code security configuration and attachment status */ - "code-security-configuration-repositories": { - /** - * @description The attachment status of the code security configuration on the repository. - * @enum {string} - */ - status?: "attached" | "attaching" | "detached" | "removed" | "enforced" | "failed" | "updating" | "removed_by_enterprise"; - repository?: components["schemas"]["simple-repository"]; - }; /** * Codespace machine * @description A description of the machine powering a codespace. @@ -23029,6 +23014,396 @@ export interface components { } & { [key: string]: unknown; }; + /** + * Organization Simple + * @description A GitHub organization. + */ + "nullable-organization-simple": { + /** @example github */ + login: string; + /** @example 1 */ + id: number; + /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ + node_id: string; + /** + * Format: uri + * @example https://api.github.com/orgs/github + */ + url: string; + /** + * Format: uri + * @example https://api.github.com/orgs/github/repos + */ + repos_url: string; + /** + * Format: uri + * @example https://api.github.com/orgs/github/events + */ + events_url: string; + /** @example https://api.github.com/orgs/github/hooks */ + hooks_url: string; + /** @example https://api.github.com/orgs/github/issues */ + issues_url: string; + /** @example https://api.github.com/orgs/github/members{/member} */ + members_url: string; + /** @example https://api.github.com/orgs/github/public_members{/member} */ + public_members_url: string; + /** @example https://github.com/images/error/octocat_happy.gif */ + avatar_url: string; + /** @example A great organization */ + description: string | null; + } | null; + /** + * Team Simple + * @description Groups of organization members that gives permissions on specified repositories. + */ + "nullable-team-simple": { + /** + * @description Unique identifier of the team + * @example 1 + */ + id: number; + /** @example MDQ6VGVhbTE= */ + node_id: string; + /** + * Format: uri + * @description URL for the team + * @example https://api.github.com/organizations/1/team/1 + */ + url: string; + /** @example https://api.github.com/organizations/1/team/1/members{/member} */ + members_url: string; + /** + * @description Name of the team + * @example Justice League + */ + name: string; + /** + * @description Description of the team + * @example A great team. + */ + description: string | null; + /** + * @description Permission that the team will have for its repositories + * @example admin + */ + permission: string; + /** + * @description The level of privacy this team should have + * @example closed + */ + privacy?: string; + /** + * @description The notification setting the team has set + * @example notifications_enabled + */ + notification_setting?: string; + /** + * Format: uri + * @example https://github.com/orgs/rails/teams/core + */ + html_url: string; + /** + * Format: uri + * @example https://api.github.com/organizations/1/team/1/repos + */ + repositories_url: string; + /** @example justice-league */ + slug: string; + /** + * @description Distinguished Name (DN) that team maps to within LDAP environment + * @example uid=example,ou=users,dc=github,dc=com + */ + ldap_dn?: string; + } | null; + /** + * Team + * @description Groups of organization members that gives permissions on specified repositories. + */ + team: { + id: number; + node_id: string; + name: string; + slug: string; + description: string | null; + privacy?: string; + notification_setting?: string; + permission: string; + permissions?: { + pull: boolean; + triage: boolean; + push: boolean; + maintain: boolean; + admin: boolean; + }; + /** Format: uri */ + url: string; + /** + * Format: uri + * @example https://github.com/orgs/rails/teams/core + */ + html_url: string; + members_url: string; + /** Format: uri */ + repositories_url: string; + parent: components["schemas"]["nullable-team-simple"]; + }; + /** + * Enterprise Team + * @description Group of enterprise owners and/or members + */ + "enterprise-team": { + /** Format: int64 */ + id: number; + name: string; + slug: string; + /** Format: uri */ + url: string; + /** @example disabled | all */ + sync_to_organizations: string; + /** @example 62ab9291-fae2-468e-974b-7e45096d5021 */ + group_id?: string | null; + /** + * Format: uri + * @example https://github.com/enterprises/dc/teams/justice-league + */ + html_url: string; + members_url: string; + /** Format: date-time */ + created_at: string; + /** Format: date-time */ + updated_at: string; + }; + /** + * Copilot Business Seat Detail + * @description Information about a Copilot Business seat assignment for a user, team, or organization. + */ + "copilot-seat-details": { + assignee: components["schemas"]["simple-user"]; + organization?: components["schemas"]["nullable-organization-simple"]; + /** @description The team through which the assignee is granted access to GitHub Copilot, if applicable. */ + assigning_team?: (components["schemas"]["team"] | components["schemas"]["enterprise-team"]) | null; + /** + * Format: date + * @description The pending cancellation date for the seat, in `YYYY-MM-DD` format. This will be null unless the assignee's Copilot access has been canceled during the current billing cycle. If the seat has been cancelled, this corresponds to the start of the organization's next billing cycle. + */ + pending_cancellation_date?: string | null; + /** + * Format: date-time + * @description Timestamp of user's last GitHub Copilot activity, in ISO 8601 format. + */ + last_activity_at?: string | null; + /** @description Last editor that was used by the user for a GitHub Copilot completion. */ + last_activity_editor?: string | null; + /** + * Format: date-time + * @description Timestamp of when the assignee was last granted access to GitHub Copilot, in ISO 8601 format. + */ + created_at: string; + /** + * Format: date-time + * @deprecated + * @description **Closing down notice:** This field is no longer relevant and is closing down. Use the `created_at` field to determine when the assignee was last granted access to GitHub Copilot. Timestamp of when the assignee's GitHub Copilot access was last updated, in ISO 8601 format. + */ + updated_at?: string; + /** + * @description The Copilot plan of the organization, or the parent enterprise, when applicable. + * @enum {string} + */ + plan_type?: "business" | "enterprise" | "unknown"; + }; + /** @description Usage metrics for Copilot editor code completions in the IDE. */ + "copilot-ide-code-completions": ({ + /** @description Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances. */ + total_engaged_users?: number; + /** @description Code completion metrics for active languages. */ + languages?: { + /** @description Name of the language used for Copilot code completion suggestions. */ + name?: string; + /** @description Number of users who accepted at least one Copilot code completion suggestion for the given language. Includes both full and partial acceptances. */ + total_engaged_users?: number; + }[]; + editors?: ({ + /** @description Name of the given editor. */ + name?: string; + /** @description Number of users who accepted at least one Copilot code completion suggestion for the given editor. Includes both full and partial acceptances. */ + total_engaged_users?: number; + /** @description List of model metrics for custom models and the default model. */ + models?: { + /** @description Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'. */ + name?: string; + /** @description Indicates whether a model is custom or default. */ + is_custom_model?: boolean; + /** @description The training date for the custom model. */ + custom_model_training_date?: string | null; + /** @description Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances. */ + total_engaged_users?: number; + /** @description Code completion metrics for active languages, for the given editor. */ + languages?: { + /** @description Name of the language used for Copilot code completion suggestions, for the given editor. */ + name?: string; + /** @description Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language. Includes both full and partial acceptances. */ + total_engaged_users?: number; + /** @description The number of Copilot code suggestions generated for the given editor, for the given language. */ + total_code_suggestions?: number; + /** @description The number of Copilot code suggestions accepted for the given editor, for the given language. Includes both full and partial acceptances. */ + total_code_acceptances?: number; + /** @description The number of lines of code suggested by Copilot code completions for the given editor, for the given language. */ + total_code_lines_suggested?: number; + /** @description The number of lines of code accepted from Copilot code suggestions for the given editor, for the given language. */ + total_code_lines_accepted?: number; + }[]; + }[]; + } & { + [key: string]: unknown; + })[]; + } & { + [key: string]: unknown; + }) | null; + /** @description Usage metrics for Copilot Chat in the IDE. */ + "copilot-ide-chat": ({ + /** @description Total number of users who prompted Copilot Chat in the IDE. */ + total_engaged_users?: number; + editors?: { + /** @description Name of the given editor. */ + name?: string; + /** @description The number of users who prompted Copilot Chat in the specified editor. */ + total_engaged_users?: number; + /** @description List of model metrics for custom models and the default model. */ + models?: { + /** @description Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'. */ + name?: string; + /** @description Indicates whether a model is custom or default. */ + is_custom_model?: boolean; + /** @description The training date for the custom model. */ + custom_model_training_date?: string | null; + /** @description The number of users who prompted Copilot Chat in the given editor and model. */ + total_engaged_users?: number; + /** @description The total number of chats initiated by users in the given editor and model. */ + total_chats?: number; + /** @description The number of times users accepted a code suggestion from Copilot Chat using the 'Insert Code' UI element, for the given editor. */ + total_chat_insertion_events?: number; + /** @description The number of times users copied a code suggestion from Copilot Chat using the keyboard, or the 'Copy' UI element, for the given editor. */ + total_chat_copy_events?: number; + }[]; + }[]; + } & { + [key: string]: unknown; + }) | null; + /** @description Usage metrics for Copilot Chat in github.com */ + "copilot-dotcom-chat": ({ + /** @description Total number of users who prompted Copilot Chat on github.com at least once. */ + total_engaged_users?: number; + /** @description List of model metrics for a custom models and the default model. */ + models?: { + /** @description Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'. */ + name?: string; + /** @description Indicates whether a model is custom or default. */ + is_custom_model?: boolean; + /** @description The training date for the custom model (if applicable). */ + custom_model_training_date?: string | null; + /** @description Total number of users who prompted Copilot Chat on github.com at least once for each model. */ + total_engaged_users?: number; + /** @description Total number of chats initiated by users on github.com. */ + total_chats?: number; + }[]; + } & { + [key: string]: unknown; + }) | null; + /** @description Usage metrics for Copilot for pull requests. */ + "copilot-dotcom-pull-requests": ({ + /** @description The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once. */ + total_engaged_users?: number; + /** @description Repositories in which users used Copilot for Pull Requests to generate pull request summaries */ + repositories?: { + /** @description Repository name */ + name?: string; + /** @description The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository. */ + total_engaged_users?: number; + /** @description List of model metrics for custom models and the default model. */ + models?: { + /** @description Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'. */ + name?: string; + /** @description Indicates whether a model is custom or default. */ + is_custom_model?: boolean; + /** @description The training date for the custom model. */ + custom_model_training_date?: string | null; + /** @description The number of pull request summaries generated using Copilot for Pull Requests in the given repository. */ + total_pr_summaries_created?: number; + /** @description The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository and model. */ + total_engaged_users?: number; + }[]; + }[]; + } & { + [key: string]: unknown; + }) | null; + /** + * Copilot Usage Metrics + * @description Copilot usage metrics for a given day. + */ + "copilot-usage-metrics-day": { + /** + * Format: date + * @description The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format. + */ + date: string; + /** @description The total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint. */ + total_active_users?: number; + /** @description The total number of Copilot users who engaged with any Copilot feature, for the given day. Examples include but are not limited to accepting a code suggestion, prompting Copilot chat, or triggering a PR Summary. Does not include authentication events. Is not limited to the individual features detailed on the endpoint. */ + total_engaged_users?: number; + copilot_ide_code_completions?: components["schemas"]["copilot-ide-code-completions"]; + copilot_ide_chat?: components["schemas"]["copilot-ide-chat"]; + copilot_dotcom_chat?: components["schemas"]["copilot-dotcom-chat"]; + copilot_dotcom_pull_requests?: components["schemas"]["copilot-dotcom-pull-requests"]; + } & { + [key: string]: unknown; + }; + /** + * Copilot Usage Metrics + * @description Summary of Copilot usage. + */ + "copilot-usage-metrics": { + /** + * Format: date + * @description The date for which the usage metrics are reported, in `YYYY-MM-DD` format. + */ + day: string; + /** @description The total number of Copilot code completion suggestions shown to users. */ + total_suggestions_count?: number; + /** @description The total number of Copilot code completion suggestions accepted by users. */ + total_acceptances_count?: number; + /** @description The total number of lines of code completions suggested by Copilot. */ + total_lines_suggested?: number; + /** @description The total number of lines of code completions accepted by users. */ + total_lines_accepted?: number; + /** @description The total number of users who were shown Copilot code completion suggestions during the day specified. */ + total_active_users?: number; + /** @description The total instances of users who accepted code suggested by Copilot Chat in the IDE (panel and inline). */ + total_chat_acceptances?: number; + /** @description The total number of chat turns (prompt and response pairs) sent between users and Copilot Chat in the IDE. */ + total_chat_turns?: number; + /** @description The total number of users who interacted with Copilot Chat in the IDE during the day specified. */ + total_active_chat_users?: number; + /** @description Breakdown of Copilot code completions usage by language and editor */ + breakdown: ({ + /** @description The language in which Copilot suggestions were shown to users in the specified editor. */ + language?: string; + /** @description The editor in which Copilot suggestions were shown to users for the specified language. */ + editor?: string; + /** @description The number of Copilot suggestions shown to users in the editor specified during the day specified. */ + suggestions_count?: number; + /** @description The number of Copilot suggestions accepted by users in the editor specified during the day specified. */ + acceptances_count?: number; + /** @description The number of lines of code suggested by Copilot in the editor specified during the day specified. */ + lines_suggested?: number; + /** @description The number of lines of code accepted by users in the editor specified during the day specified. */ + lines_accepted?: number; + /** @description The number of users who were shown Copilot completion suggestions in the editor specified during the day specified. */ + active_users?: number; + } & { + [key: string]: unknown; + })[] | null; + }; /** * Dependabot Secret for an Organization * @description Secrets for GitHub Dependabot for an organization. @@ -23608,6 +23983,16 @@ export interface components { name: string; /** @description A short description about who this role is for or what permissions it grants. */ description?: string | null; + /** + * @description The system role from which this role inherits permissions. + * @enum {string|null} + */ + base_role?: "read" | "triage" | "write" | "maintain" | "admin" | null; + /** + * @description Source answers the question, "where did this role come from?" + * @enum {string|null} + */ + source?: "Organization" | "Enterprise" | "Predefined" | null; /** @description A list of permissions included in this role. */ permissions: string[]; organization: components["schemas"]["nullable-simple-user"]; @@ -23627,6 +24012,12 @@ export interface components { * @description The Relationship a Team has with a role. */ "team-role-assignment": { + /** + * @description Determines if the team has a direct, indirect, or mixed relationship to a role + * @example direct + * @enum {string} + */ + assignment?: "direct" | "indirect" | "mixed"; id: number; node_id: string; name: string; @@ -23722,6 +24113,14 @@ export interface components { * @description The Relationship a User has with a role. */ "user-role-assignment": { + /** + * @description Determines if the user has a direct, indirect, or mixed relationship to a role + * @example direct + * @enum {string} + */ + assignment?: "direct" | "indirect" | "mixed"; + /** @description Team the user has gotten the role through */ + inherited_from?: components["schemas"]["team-simple"][]; name?: string | null; email?: string | null; /** @example octocat */ @@ -23926,6 +24325,68 @@ export interface components { /** @description Date and time when the associated fine-grained personal access token was last used for authentication. */ token_last_used_at: string | null; }; + /** + * Organization private registry + * @description Private registry configuration for an organization + */ + "org-private-registry-configuration": { + /** + * @description The name of the private registry configuration. + * @example MAVEN_REPOSITORY_SECRET + */ + name: string; + /** + * @description The registry type. + * @enum {string} + */ + registry_type: "maven_repository"; + /** + * @description The username to use when authenticating with the private registry. + * @example monalisa + */ + username?: string | null; + /** + * @description Which type of organization repositories have access to the private registry. + * @enum {string} + */ + visibility: "all" | "private" | "selected"; + /** Format: date-time */ + created_at: string; + /** Format: date-time */ + updated_at: string; + }; + /** + * Organization private registry + * @description Private registry configuration for an organization + */ + "org-private-registry-configuration-with-selected-repositories": { + /** + * @description The name of the private registry configuration. + * @example MAVEN_REPOSITORY_SECRET + */ + name: string; + /** + * @description The registry type. + * @enum {string} + */ + registry_type: "maven_repository"; + /** + * @description The username to use when authenticating with the private registry. + * @example monalisa + */ + username?: string; + /** + * @description Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry. + * @enum {string} + */ + visibility: "all" | "private" | "selected"; + /** @description An array of repository IDs that can access the organization private registry when `visibility` is set to `selected`. */ + selected_repository_ids?: number[]; + /** Format: date-time */ + created_at: string; + /** Format: date-time */ + updated_at: string; + }; /** * Project * @description Projects are a way to organize columns and cards of work. @@ -24003,6 +24464,12 @@ export interface components { * @description The URL that can be used to fetch, update, or delete info about this property via the API. */ url?: string; + /** + * @description The source type of the property + * @example organization + * @enum {string} + */ + source_type?: "organization" | "enterprise"; /** * @description The type of the value for the property * @example single_select @@ -24025,6 +24492,27 @@ export interface components { */ values_editable_by?: "org_actors" | "org_and_repo_actors" | null; }; + /** + * Custom Property Set Payload + * @description Custom property set payload + */ + "custom-property-set-payload": { + /** + * @description The type of the value for the property + * @example single_select + * @enum {string} + */ + value_type: "string" | "single_select" | "multi_select" | "true_false"; + /** @description Whether the property is required. */ + required?: boolean; + /** @description Default value of the property */ + default_value?: (string | string[]) | null; + /** @description Short description of the property */ + description?: string | null; + /** @description An ordered list of the allowed values of the property. + * The property can have up to 200 allowed values. */ + allowed_values?: string[] | null; + }; /** * Custom Property Value * @description Custom property name and associated value @@ -24829,6 +25317,7 @@ export interface components { * @description Conditions for an organization ruleset. * The branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties. * The push rulesets conditions object does not require the `ref_name` property. + * For repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`. */ "org-ruleset-conditions": (components["schemas"]["repository-ruleset-conditions"] & components["schemas"]["repository-ruleset-conditions-repository-name-target"]) | (components["schemas"]["repository-ruleset-conditions"] & components["schemas"]["repository-ruleset-conditions-repository-id-target"]) | (components["schemas"]["repository-ruleset-conditions"] & components["schemas"]["repository-ruleset-conditions-repository-property-target"]); /** @@ -24937,6 +25426,8 @@ export interface components { /** @enum {string} */ type: "pull_request"; parameters?: { + /** @description When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled. */ + allowed_merge_methods?: string[]; /** @description New, reviewable commits pushed will dismiss previous pull request review approvals. */ dismiss_stale_reviews_on_push: boolean; /** @description Require an approving review in pull requests that modify files that have a designated code owner. */ @@ -25202,12 +25693,12 @@ export interface components { * @description The target of the ruleset * @enum {string} */ - target?: "branch" | "tag" | "push"; + target?: "branch" | "tag" | "push" | "repository"; /** * @description The type of the source of the ruleset * @enum {string} */ - source_type?: "Repository" | "Organization"; + source_type?: "Repository" | "Organization" | "Enterprise"; /** @description The name of the source */ source: string; enforcement: components["schemas"]["repository-rule-enforcement"]; @@ -26361,6 +26852,7 @@ export interface components { actions_runner_registration?: components["schemas"]["rate-limit"]; scim?: components["schemas"]["rate-limit"]; dependency_snapshots?: components["schemas"]["rate-limit"]; + code_scanning_autofix?: components["schemas"]["rate-limit"]; }; rate: components["schemas"]["rate-limit"]; }; @@ -27498,6 +27990,7 @@ export interface components { reason: string; payload: string | null; signature: string | null; + verified_at?: string | null; }; /** * Diff Entry @@ -28069,6 +28562,36 @@ export interface components { * @enum {string} */ "code-scanning-alert-set-state": "open" | "dismissed"; + /** + * @description The status of an autofix. + * @enum {string} + */ + "code-scanning-autofix-status": "pending" | "error" | "success" | "outdated"; + /** @description The description of an autofix. */ + "code-scanning-autofix-description": string | null; + /** + * Format: date-time + * @description The start time of an autofix in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + "code-scanning-autofix-started-at": string; + "code-scanning-autofix": { + status: components["schemas"]["code-scanning-autofix-status"]; + description: components["schemas"]["code-scanning-autofix-description"]; + started_at: components["schemas"]["code-scanning-autofix-started-at"]; + }; + /** @description Commit an autofix for a code scanning alert */ + "code-scanning-autofix-commits": { + /** @description The Git reference of target branch for the commit. Branch needs to already exist. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ + target_ref?: string; + /** @description Commit message to be used. */ + message?: string; + } | null; + "code-scanning-autofix-commits-response": { + /** @description The Git reference of target branch for the commit. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ + target_ref?: string; + /** @description SHA of commit with autofix. */ + sha?: string; + }; /** * @description An identifier for the upload. * @example 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53 @@ -28298,7 +28821,7 @@ export interface components { */ state?: "configured" | "not-configured"; /** @description Languages to be analyzed. */ - languages?: ("c-cpp" | "csharp" | "go" | "java-kotlin" | "javascript-typescript" | "javascript" | "python" | "ruby" | "typescript" | "swift")[]; + languages?: ("actions" | "c-cpp" | "csharp" | "go" | "java-kotlin" | "javascript-typescript" | "javascript" | "python" | "ruby" | "typescript" | "swift")[]; /** * @description CodeQL query suite to be used. * @enum {string} @@ -28323,13 +28846,23 @@ export interface components { * @enum {string} */ state?: "configured" | "not-configured"; + /** + * @description Runner type to be used. + * @enum {string} + */ + runner_type?: "standard" | "labeled"; + /** + * @description Runner label to be used if the runner type is labeled. + * @example code-scanning + */ + runner_label?: string | null; /** * @description CodeQL query suite to be used. * @enum {string} */ query_suite?: "default" | "extended"; /** @description CodeQL languages to be analyzed. */ - languages?: ("c-cpp" | "csharp" | "go" | "java-kotlin" | "javascript-typescript" | "python" | "ruby" | "swift")[]; + languages?: ("actions" | "c-cpp" | "csharp" | "go" | "java-kotlin" | "javascript-typescript" | "python" | "ruby" | "swift")[]; }; /** @description You can use `run_url` to track the status of the run. This includes a property status and conclusion. * You should not rely on this always being an actions workflow run object. */ @@ -29285,6 +29818,7 @@ export interface components { reason?: string; signature?: string | null; payload?: string | null; + verified_at?: string | null; }; }; }; @@ -30039,6 +30573,7 @@ export interface components { reason: string; signature: string | null; payload: string | null; + verified_at?: string | null; }; /** Format: uri */ html_url: string; @@ -30400,6 +30935,7 @@ export interface components { performed_via_github_app?: components["schemas"]["nullable-integration"]; author_association: components["schemas"]["author-association"]; reactions?: components["schemas"]["reaction-rollup"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; } | null; /** * Issue Event Label @@ -30978,6 +31514,7 @@ export interface components { reason: string; signature: string | null; payload: string | null; + verified_at?: string | null; }; /** Format: uri */ html_url: string; @@ -32114,6 +32651,16 @@ export interface components { * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ push_protection_bypassed_at?: string | null; + push_protection_bypass_request_reviewer?: components["schemas"]["nullable-simple-user"]; + /** @description An optional comment when reviewing a push protection bypass. */ + push_protection_bypass_request_reviewer_comment?: string | null; + /** @description An optional comment when requesting a push protection bypass. */ + push_protection_bypass_request_comment?: string | null; + /** + * Format: uri + * @description The URL to a push protection bypass request. + */ + push_protection_bypass_request_html_url?: string | null; /** * @description The token status as of the latest validity check. * @enum {string} @@ -32251,7 +32798,7 @@ export interface components { /** * Format: uri * @description The API URL to get the pull request where the secret was detected. - * @example https://api.github.com/repos/octocat/Hello-World/pull/2846 + * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846 */ pull_request_title_url: string; }; @@ -32260,7 +32807,7 @@ export interface components { /** * Format: uri * @description The API URL to get the pull request where the secret was detected. - * @example https://api.github.com/repos/octocat/Hello-World/pull/2846 + * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846 */ pull_request_body_url: string; }; @@ -32315,6 +32862,34 @@ export interface components { /** @description The token type this bypass is for. */ token_type?: string; }; + /** @description Information on a single scan performed by secret scanning on the repository */ + "secret-scanning-scan": { + /** @description The type of scan */ + type?: string; + /** @description The state of the scan. Either "completed", "running", or "pending" */ + status?: string; + /** + * Format: date-time + * @description The time that the scan was completed. Empty if the scan is running + */ + completed_at?: string | null; + /** + * Format: date-time + * @description The time that the scan was started. Empty if the scan is pending + */ + started_at?: string | null; + }; + "secret-scanning-scan-history": { + incremental_scans?: components["schemas"]["secret-scanning-scan"][]; + pattern_update_scans?: components["schemas"]["secret-scanning-scan"][]; + backfill_scans?: components["schemas"]["secret-scanning-scan"][]; + custom_pattern_backfill_scans?: (components["schemas"]["secret-scanning-scan"] & { + /** @description Name of the custom pattern for custom pattern scans */ + pattern_name?: string; + /** @description Level at which the custom pattern is defined, one of "repository", "organization", or "enterprise" */ + pattern_scope?: string; + })[]; + }; "repository-advisory-create": { /** @description A short summary of the advisory. */ summary: string; @@ -32749,6 +33324,12 @@ export interface components { default?: boolean; description?: string | null; }[]; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; state: string; state_reason?: string | null; assignee: components["schemas"]["nullable-simple-user"]; @@ -35340,6 +35921,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -35828,6 +36415,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -38908,6 +39501,16 @@ export interface components { * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ push_protection_bypassed_at?: string | null; + push_protection_bypass_request_reviewer?: components["schemas"]["nullable-simple-user"]; + /** @description An optional comment when reviewing a push protection bypass. */ + push_protection_bypass_request_reviewer_comment?: string | null; + /** @description An optional comment when requesting a push protection bypass. */ + push_protection_bypass_request_comment?: string | null; + /** + * Format: uri + * @description The URL to a push protection bypass request. + */ + push_protection_bypass_request_html_url?: string | null; /** @description Whether the detected secret was publicly leaked. */ publicly_leaked?: boolean | null; /** @description Whether the detected secret was found in multiple repositories in the same organization or business. */ @@ -43992,21 +44595,424 @@ export interface components { * @enum {string} */ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue comment */ - body: string; + /** @description Contents of the issue comment */ + body: string; + /** Format: date-time */ + created_at: string; + /** Format: uri */ + html_url: string; + /** + * Format: int64 + * @description Unique identifier of the issue comment + */ + id: number; + /** Format: uri */ + issue_url: string; + node_id: string; + performed_via_github_app: components["schemas"]["nullable-integration"]; + /** Reactions */ + reactions: { + "+1": number; + "-1": number; + confused: number; + eyes: number; + heart: number; + hooray: number; + laugh: number; + rocket: number; + total_count: number; + /** Format: uri */ + url: string; + }; + /** Format: date-time */ + updated_at: string; + /** + * Format: uri + * @description URL for the issue comment + */ + url: string; + /** User */ + user: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + /** Format: int64 */ + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null; + }; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. */ + issue: { + /** @enum {string|null} */ + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + /** User */ + assignee?: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization" | "Mannequin"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null; + assignees: ({ + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization" | "Mannequin"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null)[]; + /** + * AuthorAssociation + * @description How the author is associated with the repository. + * @enum {string} + */ + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + /** @description Contents of the issue */ + body: string | null; + /** Format: date-time */ + closed_at: string | null; + comments: number; + /** Format: uri */ + comments_url: string; /** Format: date-time */ created_at: string; + draft?: boolean; + /** Format: uri */ + events_url: string; /** Format: uri */ html_url: string; + /** Format: int64 */ + id: number; + labels?: { + /** @description 6-character hex code, without the leading #, identifying the color */ + color: string; + default: boolean; + description: string | null; + id: number; + /** @description The name of the label. */ + name: string; + node_id: string; + /** + * Format: uri + * @description URL for the label + */ + url: string; + }[]; + /** Format: uri-template */ + labels_url: string; + locked?: boolean; /** - * Format: int64 - * @description Unique identifier of the issue comment + * Milestone + * @description A collection of related issues and pull requests. */ - id: number; - /** Format: uri */ - issue_url: string; + milestone: { + /** Format: date-time */ + closed_at: string | null; + closed_issues: number; + /** Format: date-time */ + created_at: string; + /** User */ + creator: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization" | "Mannequin"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null; + description: string | null; + /** Format: date-time */ + due_on: string | null; + /** Format: uri */ + html_url: string; + id: number; + /** Format: uri */ + labels_url: string; + node_id: string; + /** @description The number of the milestone. */ + number: number; + open_issues: number; + /** + * @description The state of the milestone. + * @enum {string} + */ + state: "open" | "closed"; + /** @description The title of the milestone. */ + title: string; + /** Format: date-time */ + updated_at: string; + /** Format: uri */ + url: string; + } | null; node_id: string; - performed_via_github_app: components["schemas"]["nullable-integration"]; + number: number; + /** + * App + * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. + */ + performed_via_github_app?: { + /** Format: date-time */ + created_at: string | null; + description: string | null; + /** @description The list of events for the GitHub app */ + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "pull_request_review_thread")[]; + /** Format: uri */ + external_url: string | null; + /** Format: uri */ + html_url: string; + /** @description Unique identifier of the GitHub app */ + id: number | null; + /** @description The name of the GitHub app */ + name: string; + node_id: string; + /** User */ + owner: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null; + /** @description The set of permissions for the GitHub app */ + permissions?: { + /** @enum {string} */ + actions?: "read" | "write"; + /** @enum {string} */ + administration?: "read" | "write"; + /** @enum {string} */ + checks?: "read" | "write"; + /** @enum {string} */ + content_references?: "read" | "write"; + /** @enum {string} */ + contents?: "read" | "write"; + /** @enum {string} */ + deployments?: "read" | "write"; + /** @enum {string} */ + discussions?: "read" | "write"; + /** @enum {string} */ + emails?: "read" | "write"; + /** @enum {string} */ + environments?: "read" | "write"; + /** @enum {string} */ + issues?: "read" | "write"; + /** @enum {string} */ + keys?: "read" | "write"; + /** @enum {string} */ + members?: "read" | "write"; + /** @enum {string} */ + metadata?: "read" | "write"; + /** @enum {string} */ + organization_administration?: "read" | "write"; + /** @enum {string} */ + organization_hooks?: "read" | "write"; + /** @enum {string} */ + organization_packages?: "read" | "write"; + /** @enum {string} */ + organization_plan?: "read" | "write"; + /** @enum {string} */ + organization_projects?: "read" | "write" | "admin"; + /** @enum {string} */ + organization_secrets?: "read" | "write"; + /** @enum {string} */ + organization_self_hosted_runners?: "read" | "write"; + /** @enum {string} */ + organization_user_blocking?: "read" | "write"; + /** @enum {string} */ + packages?: "read" | "write"; + /** @enum {string} */ + pages?: "read" | "write"; + /** @enum {string} */ + pull_requests?: "read" | "write"; + /** @enum {string} */ + repository_hooks?: "read" | "write"; + /** @enum {string} */ + repository_projects?: "read" | "write" | "admin"; + /** @enum {string} */ + secret_scanning_alerts?: "read" | "write"; + /** @enum {string} */ + secrets?: "read" | "write"; + /** @enum {string} */ + security_events?: "read" | "write"; + /** @enum {string} */ + security_scanning_alert?: "read" | "write"; + /** @enum {string} */ + single_file?: "read" | "write"; + /** @enum {string} */ + statuses?: "read" | "write"; + /** @enum {string} */ + team_discussions?: "read" | "write"; + /** @enum {string} */ + vulnerability_alerts?: "read" | "write"; + /** @enum {string} */ + workflows?: "read" | "write"; + }; + /** @description The slug name of the GitHub app */ + slug?: string; + /** Format: date-time */ + updated_at: string | null; + } | null; + pull_request?: { + /** Format: uri */ + diff_url?: string; + /** Format: uri */ + html_url?: string; + /** Format: date-time */ + merged_at?: string | null; + /** Format: uri */ + patch_url?: string; + /** Format: uri */ + url?: string; + }; /** Reactions */ reactions: { "+1": number; @@ -44021,11 +45027,29 @@ export interface components { /** Format: uri */ url: string; }; + /** Format: uri */ + repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; + /** + * @description State of the issue; either 'open' or 'closed' + * @enum {string} + */ + state?: "open" | "closed"; + state_reason?: string | null; + /** Format: uri */ + timeline_url?: string; + /** @description Title of the issue */ + title: string; /** Format: date-time */ updated_at: string; /** * Format: uri - * @description URL for the issue comment + * @description URL for the issue */ url: string; /** User */ @@ -44062,12 +45086,135 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null; + } & { + active_lock_reason?: string | null; + /** User */ + assignee: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; user_view_type?: string; } | null; + assignees?: Record[]; + author_association?: string; + body?: string | null; + closed_at?: string | null; + comments?: number; + comments_url?: string; + created_at?: string; + events_url?: string; + html_url?: string; + id?: number; + labels: { + /** @description 6-character hex code, without the leading #, identifying the color */ + color: string; + default: boolean; + description: string | null; + id: number; + /** @description The name of the label. */ + name: string; + node_id: string; + /** + * Format: uri + * @description URL for the label + */ + url: string; + }[]; + labels_url?: string; + locked: boolean; + milestone?: Record; + node_id?: string; + number?: number; + performed_via_github_app?: Record; + reactions?: { + "+1"?: number; + "-1"?: number; + confused?: number; + eyes?: number; + heart?: number; + hooray?: number; + laugh?: number; + rocket?: number; + total_count?: number; + url?: string; + }; + repository_url?: string; + /** + * @description State of the issue; either 'open' or 'closed' + * @enum {string} + */ + state: "open" | "closed"; + timeline_url?: string; + title?: string; + updated_at?: string; + url?: string; + user?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + /** Format: int64 */ + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: string; + url?: string; + }; }; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; + }; + /** issue_comment deleted event */ + "webhook-issue-comment-deleted": { + /** @enum {string} */ + action: "deleted"; + comment: components["schemas"]["webhooks_issue_comment"]; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. */ @@ -44272,7 +45419,7 @@ export interface components { created_at: string | null; description: string | null; /** @description The list of events for the GitHub app */ - events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "pull_request_review_thread")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; /** Format: uri */ external_url: string | null; /** Format: uri */ @@ -44357,7 +45504,7 @@ export interface components { /** @enum {string} */ organization_plan?: "read" | "write"; /** @enum {string} */ - organization_projects?: "read" | "write" | "admin"; + organization_projects?: "read" | "write"; /** @enum {string} */ organization_secrets?: "read" | "write"; /** @enum {string} */ @@ -44373,7 +45520,7 @@ export interface components { /** @enum {string} */ repository_hooks?: "read" | "write"; /** @enum {string} */ - repository_projects?: "read" | "write" | "admin"; + repository_projects?: "read" | "write"; /** @enum {string} */ secret_scanning_alerts?: "read" | "write"; /** @enum {string} */ @@ -44426,6 +45573,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -44595,16 +45748,18 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; }; - /** issue_comment deleted event */ - "webhook-issue-comment-deleted": { + /** issue_comment edited event */ + "webhook-issue-comment-edited": { /** @enum {string} */ - action: "deleted"; + action: "edited"; + changes: components["schemas"]["webhooks_changes"]; comment: components["schemas"]["webhooks_issue_comment"]; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; @@ -44810,7 +45965,7 @@ export interface components { created_at: string | null; description: string | null; /** @description The list of events for the GitHub app */ - events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "pull_request_review_thread")[]; /** Format: uri */ external_url: string | null; /** Format: uri */ @@ -44895,7 +46050,7 @@ export interface components { /** @enum {string} */ organization_plan?: "read" | "write"; /** @enum {string} */ - organization_projects?: "read" | "write"; + organization_projects?: "read" | "write" | "admin"; /** @enum {string} */ organization_secrets?: "read" | "write"; /** @enum {string} */ @@ -44964,6 +46119,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -45133,22 +46294,37 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; - user_view_type?: string; }; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; }; - /** issue_comment edited event */ - "webhook-issue-comment-edited": { - /** @enum {string} */ - action: "edited"; - changes: components["schemas"]["webhooks_changes"]; - comment: components["schemas"]["webhooks_issue_comment"]; + /** issues assigned event */ + "webhook-issues-assigned": { + /** + * @description The action that was performed. + * @enum {string} + */ + action: "assigned"; + assignee?: components["schemas"]["webhooks_user"]; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; - /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. */ + issue: components["schemas"]["webhooks_issue"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; + }; + /** issues closed event */ + "webhook-issues-closed": { + /** + * @description The action that was performed. + * @enum {string} + */ + action: "closed"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ issue: { /** @enum {string|null} */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; @@ -45350,7 +46526,7 @@ export interface components { created_at: string | null; description: string | null; /** @description The list of events for the GitHub app */ - events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "pull_request_review_thread")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "security_and_analysis" | "reminder" | "pull_request_review_thread")[]; /** Format: uri */ external_url: string | null; /** Format: uri */ @@ -45504,6 +46680,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -45562,71 +46744,20 @@ export interface components { } | null; } & { active_lock_reason?: string | null; - /** User */ - assignee: { - /** Format: uri */ - avatar_url?: string; - deleted?: boolean; - email?: string | null; - /** Format: uri-template */ - events_url?: string; - /** Format: uri */ - followers_url?: string; - /** Format: uri-template */ - following_url?: string; - /** Format: uri-template */ - gists_url?: string; - gravatar_id?: string; - /** Format: uri */ - html_url?: string; - id: number; - login: string; - name?: string; - node_id?: string; - /** Format: uri */ - organizations_url?: string; - /** Format: uri */ - received_events_url?: string; - /** Format: uri */ - repos_url?: string; - site_admin?: boolean; - /** Format: uri-template */ - starred_url?: string; - /** Format: uri */ - subscriptions_url?: string; - /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ - url?: string; - user_view_type?: string; - } | null; + assignee?: Record; assignees?: Record[]; author_association?: string; body?: string | null; - closed_at?: string | null; + closed_at: string | null; comments?: number; comments_url?: string; created_at?: string; events_url?: string; html_url?: string; id?: number; - labels: { - /** @description 6-character hex code, without the leading #, identifying the color */ - color: string; - default: boolean; - description: string | null; - id: number; - /** @description The name of the label. */ - name: string; - node_id: string; - /** - * Format: uri - * @description URL for the label - */ - url: string; - }[]; + labels?: Record[]; labels_url?: string; - locked: boolean; + locked?: boolean; milestone?: Record; node_id?: string; number?: number; @@ -45644,11 +46775,8 @@ export interface components { url?: string; }; repository_url?: string; - /** - * @description State of the issue; either 'open' or 'closed' - * @enum {string} - */ - state: "open" | "closed"; + /** @enum {string} */ + state: "closed" | "open"; timeline_url?: string; title?: string; updated_at?: string; @@ -45673,37 +46801,23 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; }; - /** issues assigned event */ - "webhook-issues-assigned": { - /** - * @description The action that was performed. - * @enum {string} - */ - action: "assigned"; - assignee?: components["schemas"]["webhooks_user"]; + /** issues deleted event */ + "webhook-issues-deleted": { + /** @enum {string} */ + action: "deleted"; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; - issue: components["schemas"]["webhooks_issue"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user"]; - }; - /** issues closed event */ - "webhook-issues-closed": { /** - * @description The action that was performed. - * @enum {string} + * Issue + * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ - action: "closed"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ issue: { /** @enum {string|null} */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; @@ -45740,7 +46854,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; user_view_type?: string; @@ -45777,10 +46891,9 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; - user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -45865,7 +46978,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; user_view_type?: string; @@ -45905,7 +47018,7 @@ export interface components { created_at: string | null; description: string | null; /** @description The list of events for the GitHub app */ - events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "security_and_analysis" | "reminder" | "pull_request_review_thread")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder")[]; /** Format: uri */ external_url: string | null; /** Format: uri */ @@ -45990,7 +47103,7 @@ export interface components { /** @enum {string} */ organization_plan?: "read" | "write"; /** @enum {string} */ - organization_projects?: "read" | "write" | "admin"; + organization_projects?: "read" | "write"; /** @enum {string} */ organization_secrets?: "read" | "write"; /** @enum {string} */ @@ -46059,6 +47172,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -46110,81 +47229,20 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; user_view_type?: string; } | null; - } & { - active_lock_reason?: string | null; - assignee?: Record; - assignees?: Record[]; - author_association?: string; - body?: string | null; - closed_at: string | null; - comments?: number; - comments_url?: string; - created_at?: string; - events_url?: string; - html_url?: string; - id?: number; - labels?: Record[]; - labels_url?: string; - locked?: boolean; - milestone?: Record; - node_id?: string; - number?: number; - performed_via_github_app?: Record; - reactions?: { - "+1"?: number; - "-1"?: number; - confused?: number; - eyes?: number; - heart?: number; - hooray?: number; - laugh?: number; - rocket?: number; - total_count?: number; - url?: string; - }; - repository_url?: string; - /** @enum {string} */ - state: "closed" | "open"; - timeline_url?: string; - title?: string; - updated_at?: string; - url?: string; - user?: { - avatar_url?: string; - events_url?: string; - followers_url?: string; - following_url?: string; - gists_url?: string; - gravatar_id?: string; - html_url?: string; - /** Format: int64 */ - id?: number; - login?: string; - node_id?: string; - organizations_url?: string; - received_events_url?: string; - repos_url?: string; - site_admin?: boolean; - starred_url?: string; - subscriptions_url?: string; - type?: string; - url?: string; - user_view_type?: string; - }; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; }; - /** issues deleted event */ - "webhook-issues-deleted": { + /** issues demilestoned event */ + "webhook-issues-demilestoned": { /** @enum {string} */ - action: "deleted"; + action: "demilestoned"; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** @@ -46227,10 +47285,9 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -46264,7 +47321,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; } | null)[]; @@ -46290,7 +47347,7 @@ export interface components { html_url: string; /** Format: int64 */ id: number; - labels?: { + labels?: ({ /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; @@ -46304,7 +47361,7 @@ export interface components { * @description URL for the label */ url: string; - }[]; + } | null)[]; /** Format: uri-template */ labels_url: string; locked?: boolean; @@ -46351,7 +47408,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; user_view_type?: string; @@ -46391,7 +47448,7 @@ export interface components { created_at: string | null; description: string | null; /** @description The list of events for the GitHub app */ - events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; /** Format: uri */ external_url: string | null; /** Format: uri */ @@ -46476,7 +47533,7 @@ export interface components { /** @enum {string} */ organization_plan?: "read" | "write"; /** @enum {string} */ - organization_projects?: "read" | "write"; + organization_projects?: "read" | "write" | "admin"; /** @enum {string} */ organization_secrets?: "read" | "write"; /** @enum {string} */ @@ -46545,6 +47602,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -46596,20 +47659,32 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; user_view_type?: string; } | null; }; + milestone?: components["schemas"]["webhooks_milestone"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; }; - /** issues demilestoned event */ - "webhook-issues-demilestoned": { + /** issues edited event */ + "webhook-issues-edited": { /** @enum {string} */ - action: "demilestoned"; + action: "edited"; + /** @description The changes to the issue. */ + changes: { + body?: { + /** @description The previous version of the body. */ + from: string; + }; + title?: { + /** @description The previous version of the title. */ + from: string; + }; + }; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** @@ -46655,6 +47730,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -46714,7 +47790,7 @@ export interface components { html_url: string; /** Format: int64 */ id: number; - labels?: ({ + labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; @@ -46728,7 +47804,7 @@ export interface components { * @description URL for the label */ url: string; - } | null)[]; + }[]; /** Format: uri-template */ labels_url: string; locked?: boolean; @@ -46815,7 +47891,7 @@ export interface components { created_at: string | null; description: string | null; /** @description The list of events for the GitHub app */ - events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "security_and_analysis" | "pull_request_review_thread" | "reminder")[]; /** Format: uri */ external_url: string | null; /** Format: uri */ @@ -46969,6 +48045,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -47026,26 +48108,15 @@ export interface components { user_view_type?: string; } | null; }; - milestone?: components["schemas"]["webhooks_milestone"]; + label?: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; }; - /** issues edited event */ - "webhook-issues-edited": { + /** issues labeled event */ + "webhook-issues-labeled": { /** @enum {string} */ - action: "edited"; - /** @description The changes to the issue. */ - changes: { - body?: { - /** @description The previous version of the body. */ - from: string; - }; - title?: { - /** @description The previous version of the title. */ - from: string; - }; - }; + action: "labeled"; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** @@ -47252,7 +48323,7 @@ export interface components { created_at: string | null; description: string | null; /** @description The list of events for the GitHub app */ - events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "security_and_analysis" | "pull_request_review_thread" | "reminder")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "reminder")[]; /** Format: uri */ external_url: string | null; /** Format: uri */ @@ -47406,6 +48477,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -47468,10 +48545,10 @@ export interface components { repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; }; - /** issues labeled event */ - "webhook-issues-labeled": { + /** issues locked event */ + "webhook-issues-locked": { /** @enum {string} */ - action: "labeled"; + action: "locked"; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** @@ -47514,7 +48591,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; user_view_type?: string; @@ -47551,9 +48628,10 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -47577,7 +48655,7 @@ export interface components { html_url: string; /** Format: int64 */ id: number; - labels?: { + labels?: ({ /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; @@ -47591,10 +48669,11 @@ export interface components { * @description URL for the label */ url: string; - }[]; + } | null)[]; /** Format: uri-template */ labels_url: string; - locked?: boolean; + /** @enum {boolean} */ + locked: true; /** * Milestone * @description A collection of related issues and pull requests. @@ -47638,7 +48717,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; user_view_type?: string; @@ -47678,7 +48757,7 @@ export interface components { created_at: string | null; description: string | null; /** @description The list of events for the GitHub app */ - events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "reminder")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "security_and_analysis")[]; /** Format: uri */ external_url: string | null; /** Format: uri */ @@ -47763,7 +48842,7 @@ export interface components { /** @enum {string} */ organization_plan?: "read" | "write"; /** @enum {string} */ - organization_projects?: "read" | "write" | "admin"; + organization_projects?: "read" | "write"; /** @enum {string} */ organization_secrets?: "read" | "write"; /** @enum {string} */ @@ -47832,6 +48911,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -47883,21 +48968,20 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; user_view_type?: string; } | null; }; - label?: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; }; - /** issues locked event */ - "webhook-issues-locked": { + /** issues milestoned event */ + "webhook-issues-milestoned": { /** @enum {string} */ - action: "locked"; + action: "milestoned"; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** @@ -47943,7 +49027,6 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; - user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -47980,7 +49063,6 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; - user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -48021,8 +49103,7 @@ export interface components { } | null)[]; /** Format: uri-template */ labels_url: string; - /** @enum {boolean} */ - locked: true; + locked?: boolean; /** * Milestone * @description A collection of related issues and pull requests. @@ -48066,7 +49147,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; user_view_type?: string; @@ -48106,7 +49187,7 @@ export interface components { created_at: string | null; description: string | null; /** @description The list of events for the GitHub app */ - events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "security_and_analysis")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder")[]; /** Format: uri */ external_url: string | null; /** Format: uri */ @@ -48191,7 +49272,7 @@ export interface components { /** @enum {string} */ organization_plan?: "read" | "write"; /** @enum {string} */ - organization_projects?: "read" | "write"; + organization_projects?: "read" | "write" | "admin"; /** @enum {string} */ organization_secrets?: "read" | "write"; /** @enum {string} */ @@ -48260,430 +49341,12 @@ export interface components { }; /** Format: uri */ repository_url: string; - /** - * @description State of the issue; either 'open' or 'closed' - * @enum {string} - */ - state?: "open" | "closed"; - state_reason?: string | null; - /** Format: uri */ - timeline_url?: string; - /** @description Title of the issue */ - title: string; - /** Format: date-time */ - updated_at: string; - /** - * Format: uri - * @description URL for the issue - */ - url: string; - /** User */ - user: { - /** Format: uri */ - avatar_url?: string; - deleted?: boolean; - email?: string | null; - /** Format: uri-template */ - events_url?: string; - /** Format: uri */ - followers_url?: string; - /** Format: uri-template */ - following_url?: string; - /** Format: uri-template */ - gists_url?: string; - gravatar_id?: string; - /** Format: uri */ - html_url?: string; - /** Format: int64 */ - id: number; - login: string; - name?: string; - node_id?: string; - /** Format: uri */ - organizations_url?: string; - /** Format: uri */ - received_events_url?: string; - /** Format: uri */ - repos_url?: string; - site_admin?: boolean; - /** Format: uri-template */ - starred_url?: string; - /** Format: uri */ - subscriptions_url?: string; - /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; - /** Format: uri */ - url?: string; - user_view_type?: string; - } | null; - }; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user"]; - }; - /** issues milestoned event */ - "webhook-issues-milestoned": { - /** @enum {string} */ - action: "milestoned"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - /** - * Issue - * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. - */ - issue: { - /** @enum {string|null} */ - active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ - assignee?: { - /** Format: uri */ - avatar_url?: string; - deleted?: boolean; - email?: string | null; - /** Format: uri-template */ - events_url?: string; - /** Format: uri */ - followers_url?: string; - /** Format: uri-template */ - following_url?: string; - /** Format: uri-template */ - gists_url?: string; - gravatar_id?: string; - /** Format: uri */ - html_url?: string; - id: number; - login: string; - name?: string; - node_id?: string; - /** Format: uri */ - organizations_url?: string; - /** Format: uri */ - received_events_url?: string; - /** Format: uri */ - repos_url?: string; - site_admin?: boolean; - /** Format: uri-template */ - starred_url?: string; - /** Format: uri */ - subscriptions_url?: string; - /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; - /** Format: uri */ - url?: string; - } | null; - assignees: ({ - /** Format: uri */ - avatar_url?: string; - deleted?: boolean; - email?: string | null; - /** Format: uri-template */ - events_url?: string; - /** Format: uri */ - followers_url?: string; - /** Format: uri-template */ - following_url?: string; - /** Format: uri-template */ - gists_url?: string; - gravatar_id?: string; - /** Format: uri */ - html_url?: string; - id: number; - login: string; - name?: string; - node_id?: string; - /** Format: uri */ - organizations_url?: string; - /** Format: uri */ - received_events_url?: string; - /** Format: uri */ - repos_url?: string; - site_admin?: boolean; - /** Format: uri-template */ - starred_url?: string; - /** Format: uri */ - subscriptions_url?: string; - /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; - /** Format: uri */ - url?: string; - } | null)[]; - /** - * AuthorAssociation - * @description How the author is associated with the repository. - * @enum {string} - */ - author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue */ - body: string | null; - /** Format: date-time */ - closed_at: string | null; - comments: number; - /** Format: uri */ - comments_url: string; - /** Format: date-time */ - created_at: string; - draft?: boolean; - /** Format: uri */ - events_url: string; - /** Format: uri */ - html_url: string; - /** Format: int64 */ - id: number; - labels?: ({ - /** @description 6-character hex code, without the leading #, identifying the color */ - color: string; - default: boolean; - description: string | null; - id: number; - /** @description The name of the label. */ - name: string; - node_id: string; - /** - * Format: uri - * @description URL for the label - */ - url: string; - } | null)[]; - /** Format: uri-template */ - labels_url: string; - locked?: boolean; - /** - * Milestone - * @description A collection of related issues and pull requests. - */ - milestone: { - /** Format: date-time */ - closed_at: string | null; - closed_issues: number; - /** Format: date-time */ - created_at: string; - /** User */ - creator: { - /** Format: uri */ - avatar_url?: string; - deleted?: boolean; - email?: string | null; - /** Format: uri-template */ - events_url?: string; - /** Format: uri */ - followers_url?: string; - /** Format: uri-template */ - following_url?: string; - /** Format: uri-template */ - gists_url?: string; - gravatar_id?: string; - /** Format: uri */ - html_url?: string; - id: number; - login: string; - name?: string; - node_id?: string; - /** Format: uri */ - organizations_url?: string; - /** Format: uri */ - received_events_url?: string; - /** Format: uri */ - repos_url?: string; - site_admin?: boolean; - /** Format: uri-template */ - starred_url?: string; - /** Format: uri */ - subscriptions_url?: string; - /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ - url?: string; - user_view_type?: string; - } | null; - description: string | null; - /** Format: date-time */ - due_on: string | null; - /** Format: uri */ - html_url: string; - id: number; - /** Format: uri */ - labels_url: string; - node_id: string; - /** @description The number of the milestone. */ - number: number; - open_issues: number; - /** - * @description The state of the milestone. - * @enum {string} - */ - state: "open" | "closed"; - /** @description The title of the milestone. */ - title: string; - /** Format: date-time */ - updated_at: string; - /** Format: uri */ - url: string; - } | null; - node_id: string; - number: number; - /** - * App - * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. - */ - performed_via_github_app?: { - /** Format: date-time */ - created_at: string | null; - description: string | null; - /** @description The list of events for the GitHub app */ - events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder")[]; - /** Format: uri */ - external_url: string | null; - /** Format: uri */ - html_url: string; - /** @description Unique identifier of the GitHub app */ - id: number | null; - /** @description The name of the GitHub app */ - name: string; - node_id: string; - /** User */ - owner: { - /** Format: uri */ - avatar_url?: string; - deleted?: boolean; - email?: string | null; - /** Format: uri-template */ - events_url?: string; - /** Format: uri */ - followers_url?: string; - /** Format: uri-template */ - following_url?: string; - /** Format: uri-template */ - gists_url?: string; - gravatar_id?: string; - /** Format: uri */ - html_url?: string; - id: number; - login: string; - name?: string; - node_id?: string; - /** Format: uri */ - organizations_url?: string; - /** Format: uri */ - received_events_url?: string; - /** Format: uri */ - repos_url?: string; - site_admin?: boolean; - /** Format: uri-template */ - starred_url?: string; - /** Format: uri */ - subscriptions_url?: string; - /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; - /** Format: uri */ - url?: string; - user_view_type?: string; - } | null; - /** @description The set of permissions for the GitHub app */ - permissions?: { - /** @enum {string} */ - actions?: "read" | "write"; - /** @enum {string} */ - administration?: "read" | "write"; - /** @enum {string} */ - checks?: "read" | "write"; - /** @enum {string} */ - content_references?: "read" | "write"; - /** @enum {string} */ - contents?: "read" | "write"; - /** @enum {string} */ - deployments?: "read" | "write"; - /** @enum {string} */ - discussions?: "read" | "write"; - /** @enum {string} */ - emails?: "read" | "write"; - /** @enum {string} */ - environments?: "read" | "write"; - /** @enum {string} */ - issues?: "read" | "write"; - /** @enum {string} */ - keys?: "read" | "write"; - /** @enum {string} */ - members?: "read" | "write"; - /** @enum {string} */ - metadata?: "read" | "write"; - /** @enum {string} */ - organization_administration?: "read" | "write"; - /** @enum {string} */ - organization_hooks?: "read" | "write"; - /** @enum {string} */ - organization_packages?: "read" | "write"; - /** @enum {string} */ - organization_plan?: "read" | "write"; - /** @enum {string} */ - organization_projects?: "read" | "write" | "admin"; - /** @enum {string} */ - organization_secrets?: "read" | "write"; - /** @enum {string} */ - organization_self_hosted_runners?: "read" | "write"; - /** @enum {string} */ - organization_user_blocking?: "read" | "write"; - /** @enum {string} */ - packages?: "read" | "write"; - /** @enum {string} */ - pages?: "read" | "write"; - /** @enum {string} */ - pull_requests?: "read" | "write"; - /** @enum {string} */ - repository_hooks?: "read" | "write"; - /** @enum {string} */ - repository_projects?: "read" | "write"; - /** @enum {string} */ - secret_scanning_alerts?: "read" | "write"; - /** @enum {string} */ - secrets?: "read" | "write"; - /** @enum {string} */ - security_events?: "read" | "write"; - /** @enum {string} */ - security_scanning_alert?: "read" | "write"; - /** @enum {string} */ - single_file?: "read" | "write"; - /** @enum {string} */ - statuses?: "read" | "write"; - /** @enum {string} */ - team_discussions?: "read" | "write"; - /** @enum {string} */ - vulnerability_alerts?: "read" | "write"; - /** @enum {string} */ - workflows?: "read" | "write"; - }; - /** @description The slug name of the GitHub app */ - slug?: string; - /** Format: date-time */ - updated_at: string | null; - } | null; - pull_request?: { - /** Format: uri */ - diff_url?: string; - /** Format: uri */ - html_url?: string; - /** Format: date-time */ - merged_at?: string | null; - /** Format: uri */ - patch_url?: string; - /** Format: uri */ - url?: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; }; - /** Reactions */ - reactions: { - "+1": number; - "-1": number; - confused: number; - eyes: number; - heart: number; - hooray: number; - laugh: number; - rocket: number; - total_count: number; - /** Format: uri */ - url: string; - }; - /** Format: uri */ - repository_url: string; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -49110,6 +49773,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -49776,6 +50445,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -50211,6 +50886,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -50636,6 +51317,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -51344,6 +52031,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -82571,6 +83264,45 @@ export interface components { repository: components["schemas"]["repository-webhooks"]; sender?: components["schemas"]["simple-user"]; }; + /** secret_scanning_scan completed event */ + "webhook-secret-scanning-scan-completed": { + /** @enum {string} */ + action: "completed"; + /** + * @description What type of scan was completed + * @enum {string} + */ + type: "backfill" | "custom-pattern-backfill" | "pattern-version-backfill"; + /** + * @description What type of content was scanned + * @enum {string} + */ + source: "git" | "issues" | "pull-requests" | "discussions" | "wiki"; + /** + * Format: date-time + * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + started_at: string; + /** + * Format: date-time + * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + completed_at: string; + /** @description List of patterns that were updated. This will be empty for normal backfill scans or custom pattern updates */ + secret_types?: string[] | null; + /** @description If the scan was triggered by a custom pattern update, this will be the name of the pattern that was updated */ + custom_pattern_name?: string | null; + /** + * @description If the scan was triggered by a custom pattern update, this will be the scope of the pattern that was updated + * @enum {string|null} + */ + custom_pattern_scope?: "repository" | "organization" | "enterprise" | null; + repository?: components["schemas"]["repository-webhooks"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + sender?: components["schemas"]["simple-user"]; + }; /** security_advisory published event */ "webhook-security-advisory-published": { /** @enum {string} */ @@ -82850,6 +83582,7 @@ export interface components { reason: "expired_key" | "not_signing_key" | "gpgverify_error" | "gpgverify_unavailable" | "unsigned" | "unknown_signature_type" | "no_user" | "unverified_email" | "bad_email" | "unknown_key" | "malformed_signature" | "invalid" | "valid" | "bad_cert" | "ocsp_pending"; signature: string | null; verified: boolean; + verified_at?: string | null; }; }; /** User */ @@ -86045,8 +86778,8 @@ export interface components { "application/json": components["schemas"]["basic-error"]; }; }; - /** @description Internal Error */ - internal_error: { + /** @description Conflict */ + conflict: { headers: { [name: string]: unknown; }; @@ -86054,14 +86787,12 @@ export interface components { "application/json": components["schemas"]["basic-error"]; }; }; - /** @description Copilot Usage Merics API setting is disabled at the organization or enterprise level. */ - usage_metrics_api_disabled: { + /** @description A header with no content is returned. */ + no_content: { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["basic-error"]; - }; + content?: never; }; /** @description Service unavailable */ service_unavailable: { @@ -86102,8 +86833,17 @@ export interface components { "application/json": components["schemas"]["basic-error"]; }; }; - /** @description Conflict */ - conflict: { + /** @description Billing usage report response for an organization */ + billing_usage_report_org: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["billing-usage-report"]; + }; + }; + /** @description Internal Error */ + internal_error: { headers: { [name: string]: unknown; }; @@ -86148,12 +86888,14 @@ export interface components { }; }; }; - /** @description A header with no content is returned. */ - no_content: { + /** @description Copilot Usage Merics API setting is disabled at the organization or enterprise level. */ + usage_metrics_api_disabled: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["basic-error"]; + }; }; /** @description The value of `per_page` multiplied by `page` cannot be greater than 10000. */ package_es_list_error: { @@ -86198,6 +86940,24 @@ export interface components { "application/json": components["schemas"]["basic-error"]; }; }; + /** @description Bad Request */ + code_scanning_bad_request: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + /** @description Response if the repository is archived, if GitHub Advanced Security is not enabled for this repository or if rate limit is exceeded */ + code_scanning_autofix_create_forbidden: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; /** @description Found */ found: { headers: { @@ -86271,6 +87031,8 @@ export interface components { "classroom-id": number; /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: string; + /** @description The unique identifier of the code security configuration. */ + "configuration-id": number; /** @description A comma-separated list of states. If specified, only alerts with these states will be returned. * * Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` */ @@ -86301,9 +87063,7 @@ export interface components { "pagination-last": number; /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ "secret-scanning-alert-state": "open" | "resolved"; - /** @description A comma-separated list of secret types to return. By default all secret types are returned. - * See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" - * for a complete list of secret types. */ + /** @description A comma-separated list of secret types to return. All default secret patterns are returned. To return experimental patterns, pass the token name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. */ "secret-scanning-alert-secret-type": string; /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ "secret-scanning-alert-resolution": string; @@ -86315,10 +87075,6 @@ export interface components { "secret-scanning-alert-publicly-leaked": boolean; /** @description A boolean value representing whether or not to filter alerts by the multi-repo tag being present. */ "secret-scanning-alert-multi-repo": boolean; - /** @description The slug of the enterprise team name. */ - "enterprise-team-slug": string; - /** @description The slug of the team name. */ - "team-slug": string; /** @description The unique identifier of the gist. */ "gist-id": string; /** @description The unique identifier of the comment. */ @@ -86347,6 +87103,14 @@ export interface components { "since-org": number; /** @description The organization name. The name is not case sensitive. */ org: string; + /** @description If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2024`. Default value is the current year. */ + "billing-usage-report-year": number; + /** @description If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. */ + "billing-usage-report-month": number; + /** @description If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. */ + "billing-usage-report-day": number; + /** @description If specified, only return results for a single hour. The value of `hour` is an integer between `0` and `23`. */ + "billing-usage-report-hour": number; /** @description The unique identifier of the repository. */ "repository-id": number; /** @description Only return runner groups that are allowed to be used by this repository. */ @@ -86369,26 +87133,30 @@ export interface components { "tool-name": components["schemas"]["code-scanning-analysis-tool-name"]; /** @description The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both. */ "tool-guid": components["schemas"]["code-scanning-analysis-tool-guid"]; - /** @description The unique identifier of the code security configuration. */ - "configuration-id": number; /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ "hook-id": number; /** @description The type of the actor */ - "api-insights-actor-type": "installations" | "classic_pats" | "fine_grained_pats" | "oauth_apps" | "github_apps_user_to_server"; + "api-insights-actor-type": "installation" | "classic_pat" | "fine_grained_pat" | "oauth_app" | "github_app_user_to_server"; /** @description The ID of the actor */ "api-insights-actor-id": number; - /** @description The minimum timestamp to query for stats */ + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ "api-insights-min-timestamp": string; - /** @description The maximum timestamp to query for stats */ + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ "api-insights-max-timestamp": string; /** @description The property to sort the results by. */ "api-insights-route-stats-sort": ("last_rate_limited_timestamp" | "last_request_timestamp" | "rate_limited_request_count" | "http_method" | "api_route" | "total_request_count")[]; + /** @description Providing a substring will filter results where the API route contains the substring. This is a case-insensitive search. */ + "api-insights-api-route-substring": string; /** @description The property to sort the results by. */ "api-insights-sort": ("last_rate_limited_timestamp" | "last_request_timestamp" | "rate_limited_request_count" | "subject_name" | "total_request_count")[]; + /** @description Providing a substring will filter results where the subject name contains the substring. This is a case-insensitive search. */ + "api-insights-subject-name-substring": string; /** @description The ID of the user to query for stats */ "api-insights-user-id": string; /** @description The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) */ "api-insights-timestamp-increment": string; + /** @description Providing a substring will filter results where the actor name contains the substring. This is a case-insensitive search. */ + "api-insights-actor-name-substring": string; /** @description The unique identifier of the invitation. */ "invitation-id": number; /** @description The name of the codespace. */ @@ -86397,6 +87165,8 @@ export interface components { "migration-id": number; /** @description repo_name parameter */ "repo-name": string; + /** @description The slug of the team name. */ + "team-slug": string; /** @description The unique identifier of the role. */ "role-id": number; /** @description The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -86433,8 +87203,8 @@ export interface components { "ruleset-targets": string; /** @description The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. */ "ref-in-query": string; - /** @description The name of the repository to filter on. When specified, only rule evaluations from this repository will be returned. */ - "repository-name-in-query": number; + /** @description The name of the repository to filter on. */ + "repository-name-in-query": string; /** @description The time period to filter by. * * For example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for insights that occurred in the past 7 days (168 hours). */ @@ -87519,13 +88289,15 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; - "copilot/list-copilot-seats-for-enterprise": { + "code-security/get-configurations-for-enterprise": { parameters: { query?: { - /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - page?: components["parameters"]["page"]; /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: number; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + before?: components["parameters"]["pagination-before"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + after?: components["parameters"]["pagination-after"]; }; header?: never; path: { @@ -87539,39 +88311,164 @@ export interface operations { /** @description Response */ 200: { headers: { - Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": { - /** @description The total number of Copilot seats the enterprise is being billed for. Users with access through multiple organizations or enterprise teams are only counted once. */ - total_seats?: number; - seats?: components["schemas"]["copilot-seat-details"][]; + "application/json": components["schemas"]["code-security-configuration"][]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "code-security/create-configuration-for-enterprise": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + enterprise: components["parameters"]["enterprise"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description The name of the code security configuration. Must be unique within the enterprise. */ + name: string; + /** @description A description of the code security configuration */ + description: string; + /** + * @description The enablement status of GitHub Advanced Security + * @default disabled + * @enum {string} + */ + advanced_security?: "enabled" | "disabled"; + /** + * @description The enablement status of Dependency Graph + * @default enabled + * @enum {string} + */ + dependency_graph?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Automatic dependency submission + * @default disabled + * @enum {string} + */ + dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for Automatic dependency submission */ + dependency_graph_autosubmit_action_options?: { + /** + * @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. + * @default false + */ + labeled_runners?: boolean; }; + /** + * @description The enablement status of Dependabot alerts + * @default disabled + * @enum {string} + */ + dependabot_alerts?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot security updates + * @default disabled + * @enum {string} + */ + dependabot_security_updates?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of code scanning default setup + * @default disabled + * @enum {string} + */ + code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; + code_scanning_default_setup_options?: components["schemas"]["code-scanning-default-setup-options"]; + /** + * @description The enablement status of secret scanning + * @default disabled + * @enum {string} + */ + secret_scanning?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning push protection + * @default disabled + * @enum {string} + */ + secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning validity checks + * @default disabled + * @enum {string} + */ + secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning non provider patterns + * @default disabled + * @enum {string} + */ + secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of private vulnerability reporting + * @default disabled + * @enum {string} + */ + private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; + /** + * @description The enforcement status for a security configuration + * @default enforced + * @enum {string} + */ + enforcement?: "enforced" | "unenforced"; }; }; - 401: components["responses"]["requires_authentication"]; + }; + responses: { + /** @description Successfully created code security configuration */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["code-security-configuration"]; + }; + }; + 400: components["responses"]["bad_request"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; }; }; - "copilot/copilot-metrics-for-enterprise": { + "code-security/get-default-configurations-for-enterprise": { parameters: { - query?: { - /** @description Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago. */ - since?: string; - /** @description Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed. */ - until?: string; - /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - page?: components["parameters"]["page"]; - /** @description The number of days of metrics to display per page (max 28). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - per_page?: number; + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + enterprise: components["parameters"]["enterprise"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["code-security-default-configurations"]; + }; }; + }; + }; + "code-security/get-single-configuration-for-enterprise": { + parameters: { + query?: never; header?: never; path: { /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description The unique identifier of the code security configuration. */ + configuration_id: components["parameters"]["configuration-id"]; }; cookie?: never; }; @@ -87583,31 +88480,233 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["copilot-usage-metrics-day"][]; + "application/json": components["schemas"]["code-security-configuration"]; }; }; + 304: components["responses"]["not_modified"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - 422: components["responses"]["usage_metrics_api_disabled"]; - 500: components["responses"]["internal_error"]; }; }; - "copilot/usage-metrics-for-enterprise": { + "code-security/delete-configuration-for-enterprise": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The unique identifier of the code security configuration. */ + configuration_id: components["parameters"]["configuration-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 204: components["responses"]["no_content"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + }; + }; + "code-security/update-enterprise-configuration": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The unique identifier of the code security configuration. */ + configuration_id: components["parameters"]["configuration-id"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description The name of the code security configuration. Must be unique across the enterprise. */ + name?: string; + /** @description A description of the code security configuration */ + description?: string; + /** + * @description The enablement status of GitHub Advanced Security. Must be set to enabled if you want to enable any GHAS settings. + * @enum {string} + */ + advanced_security?: "enabled" | "disabled"; + /** + * @description The enablement status of Dependency Graph + * @enum {string} + */ + dependency_graph?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Automatic dependency submission + * @enum {string} + */ + dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for Automatic dependency submission */ + dependency_graph_autosubmit_action_options?: { + /** @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. */ + labeled_runners?: boolean; + }; + /** + * @description The enablement status of Dependabot alerts + * @enum {string} + */ + dependabot_alerts?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot security updates + * @enum {string} + */ + dependabot_security_updates?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of code scanning default setup + * @enum {string} + */ + code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; + code_scanning_default_setup_options?: components["schemas"]["code-scanning-default-setup-options"]; + /** + * @description The enablement status of secret scanning + * @enum {string} + */ + secret_scanning?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning push protection + * @enum {string} + */ + secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning validity checks + * @enum {string} + */ + secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning non-provider patterns + * @enum {string} + */ + secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of private vulnerability reporting + * @enum {string} + */ + private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; + /** + * @description The enforcement status for a security configuration + * @enum {string} + */ + enforcement?: "enforced" | "unenforced"; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["code-security-configuration"]; + }; + }; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + }; + }; + "code-security/attach-enterprise-configuration": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The unique identifier of the code security configuration. */ + configuration_id: components["parameters"]["configuration-id"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** + * @description The type of repositories to attach the configuration to. `selected` means the configuration will be attached to only the repositories specified by `selected_repository_ids` + * @enum {string} + */ + scope: "all" | "all_without_configurations"; + }; + }; + }; + responses: { + 202: components["responses"]["accepted"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + }; + }; + "code-security/set-configuration-as-default-for-enterprise": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The unique identifier of the code security configuration. */ + configuration_id: components["parameters"]["configuration-id"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** + * @description Specify which types of repository this security configuration should be applied to by default. + * @enum {string} + */ + default_for_new_repos?: "all" | "none" | "private_and_internal" | "public"; + }; + }; + }; + responses: { + /** @description Default successfully changed. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * @description Specifies which types of repository this security configuration is applied to by default. + * @enum {string} + */ + default_for_new_repos?: "all" | "none" | "private_and_internal" | "public"; + configuration?: components["schemas"]["code-security-configuration"]; + }; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "code-security/get-repositories-for-enterprise-configuration": { parameters: { query?: { - /** @description Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago. */ - since?: string; - /** @description Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed. */ - until?: string; - /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - page?: components["parameters"]["page"]; - /** @description The number of days of metrics to display per page (max 28). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: number; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + before?: components["parameters"]["pagination-before"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + after?: components["parameters"]["pagination-after"]; + /** @description A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned. + * + * Can be: `all`, `attached`, `attaching`, `removed`, `enforced`, `failed`, `updating`, `removed_by_enterprise` */ + status?: string; }; header?: never; path: { /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description The unique identifier of the code security configuration. */ + configuration_id: components["parameters"]["configuration-id"]; }; cookie?: never; }; @@ -87619,13 +88718,11 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["copilot-usage-metrics"][]; + "application/json": components["schemas"]["code-security-configuration-repositories"][]; }; }; - 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; }; }; "dependabot/list-alerts-for-enterprise": { @@ -87697,9 +88794,7 @@ export interface operations { query?: { /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ state?: components["parameters"]["secret-scanning-alert-state"]; - /** @description A comma-separated list of secret types to return. By default all secret types are returned. - * See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" - * for a complete list of secret types. */ + /** @description A comma-separated list of secret types to return. All default secret patterns are returned. To return experimental patterns, pass the token name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. */ secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ resolution?: components["parameters"]["secret-scanning-alert-resolution"]; @@ -87743,82 +88838,6 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - "copilot/copilot-metrics-for-enterprise-team": { - parameters: { - query?: { - /** @description Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago. */ - since?: string; - /** @description Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed. */ - until?: string; - /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - page?: components["parameters"]["page"]; - /** @description The number of days of metrics to display per page (max 28). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - per_page?: number; - }; - header?: never; - path: { - /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - /** @description The slug of the enterprise team name. */ - team_slug: components["parameters"]["enterprise-team-slug"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["copilot-usage-metrics-day"][]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["usage_metrics_api_disabled"]; - 500: components["responses"]["internal_error"]; - }; - }; - "copilot/usage-metrics-for-enterprise-team": { - parameters: { - query?: { - /** @description Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago. */ - since?: string; - /** @description Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed. */ - until?: string; - /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - page?: components["parameters"]["page"]; - /** @description The number of days of metrics to display per page (max 28). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - per_page?: number; - }; - header?: never; - path: { - /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - enterprise: components["parameters"]["enterprise"]; - /** @description The slug of the team name. */ - team_slug: components["parameters"]["team-slug"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["copilot-usage-metrics"][]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; - }; - }; "activity/list-public-events": { parameters: { query?: { @@ -89271,6 +90290,34 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; + "billing/get-github-billing-usage-report-org": { + parameters: { + query?: { + /** @description If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2024`. Default value is the current year. */ + year?: components["parameters"]["billing-usage-report-year"]; + /** @description If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. */ + month?: components["parameters"]["billing-usage-report-month"]; + /** @description If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. */ + day?: components["parameters"]["billing-usage-report-day"]; + /** @description If specified, only return results for a single hour. The value of `hour` is an integer between `0` and `23`. */ + hour?: components["parameters"]["billing-usage-report-hour"]; + }; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["billing_usage_report_org"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 500: components["responses"]["internal_error"]; + 503: components["responses"]["service_unavailable"]; + }; + }; "orgs/get": { parameters: { query?: never; @@ -91166,6 +92213,7 @@ export interface operations { }; }; repository_id?: number; + bundle_url?: string; }[]; }; }; @@ -91421,6 +92469,7 @@ export interface operations { * @enum {string} */ code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; + code_scanning_default_setup_options?: components["schemas"]["code-scanning-default-setup-options"]; /** * @description The enablement status of secret scanning * @default disabled @@ -91646,6 +92695,7 @@ export interface operations { * @enum {string} */ code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; + code_scanning_default_setup_options?: components["schemas"]["code-scanning-default-setup-options"]; /** * @description The enablement status of secret scanning * @enum {string} @@ -93373,10 +94423,10 @@ export interface operations { "api-insights/get-route-stats-by-actor": { parameters: { query: { - /** @description The minimum timestamp to query for stats */ + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ min_timestamp: components["parameters"]["api-insights-min-timestamp"]; - /** @description The maximum timestamp to query for stats */ - max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ @@ -93385,6 +94435,8 @@ export interface operations { direction?: components["parameters"]["direction"]; /** @description The property to sort the results by. */ sort?: components["parameters"]["api-insights-route-stats-sort"]; + /** @description Providing a substring will filter results where the API route contains the substring. This is a case-insensitive search. */ + api_route_substring?: components["parameters"]["api-insights-api-route-substring"]; }; header?: never; path: { @@ -93413,10 +94465,10 @@ export interface operations { "api-insights/get-subject-stats": { parameters: { query: { - /** @description The minimum timestamp to query for stats */ + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ min_timestamp: components["parameters"]["api-insights-min-timestamp"]; - /** @description The maximum timestamp to query for stats */ - max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ @@ -93425,6 +94477,8 @@ export interface operations { direction?: components["parameters"]["direction"]; /** @description The property to sort the results by. */ sort?: components["parameters"]["api-insights-sort"]; + /** @description Providing a substring will filter results where the subject name contains the substring. This is a case-insensitive search. */ + subject_name_substring?: components["parameters"]["api-insights-subject-name-substring"]; }; header?: never; path: { @@ -93449,10 +94503,10 @@ export interface operations { "api-insights/get-summary-stats": { parameters: { query: { - /** @description The minimum timestamp to query for stats */ + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ min_timestamp: components["parameters"]["api-insights-min-timestamp"]; - /** @description The maximum timestamp to query for stats */ - max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; }; header?: never; path: { @@ -93477,10 +94531,10 @@ export interface operations { "api-insights/get-summary-stats-by-user": { parameters: { query: { - /** @description The minimum timestamp to query for stats */ + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ min_timestamp: components["parameters"]["api-insights-min-timestamp"]; - /** @description The maximum timestamp to query for stats */ - max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; }; header?: never; path: { @@ -93507,10 +94561,10 @@ export interface operations { "api-insights/get-summary-stats-by-actor": { parameters: { query: { - /** @description The minimum timestamp to query for stats */ + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ min_timestamp: components["parameters"]["api-insights-min-timestamp"]; - /** @description The maximum timestamp to query for stats */ - max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; }; header?: never; path: { @@ -93539,10 +94593,10 @@ export interface operations { "api-insights/get-time-stats": { parameters: { query: { - /** @description The minimum timestamp to query for stats */ + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ min_timestamp: components["parameters"]["api-insights-min-timestamp"]; - /** @description The maximum timestamp to query for stats */ - max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; /** @description The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) */ timestamp_increment: components["parameters"]["api-insights-timestamp-increment"]; }; @@ -93569,10 +94623,10 @@ export interface operations { "api-insights/get-time-stats-by-user": { parameters: { query: { - /** @description The minimum timestamp to query for stats */ + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ min_timestamp: components["parameters"]["api-insights-min-timestamp"]; - /** @description The maximum timestamp to query for stats */ - max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; /** @description The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) */ timestamp_increment: components["parameters"]["api-insights-timestamp-increment"]; }; @@ -93601,10 +94655,10 @@ export interface operations { "api-insights/get-time-stats-by-actor": { parameters: { query: { - /** @description The minimum timestamp to query for stats */ + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ min_timestamp: components["parameters"]["api-insights-min-timestamp"]; - /** @description The maximum timestamp to query for stats */ - max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; /** @description The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) */ timestamp_increment: components["parameters"]["api-insights-timestamp-increment"]; }; @@ -93635,10 +94689,10 @@ export interface operations { "api-insights/get-user-stats": { parameters: { query: { - /** @description The minimum timestamp to query for stats */ + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ min_timestamp: components["parameters"]["api-insights-min-timestamp"]; - /** @description The maximum timestamp to query for stats */ - max_timestamp: components["parameters"]["api-insights-max-timestamp"]; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ @@ -93647,6 +94701,8 @@ export interface operations { direction?: components["parameters"]["direction"]; /** @description The property to sort the results by. */ sort?: components["parameters"]["api-insights-sort"]; + /** @description Providing a substring will filter results where the actor name contains the substring. This is a case-insensitive search. */ + actor_name_substring?: components["parameters"]["api-insights-actor-name-substring"]; }; header?: never; path: { @@ -95515,6 +96571,223 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; + "private-registries/list-org-private-registries": { + parameters: { + query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + page?: components["parameters"]["page"]; + }; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": { + total_count: number; + configurations: components["schemas"]["org-private-registry-configuration"][]; + }; + }; + }; + 400: components["responses"]["bad_request"]; + 404: components["responses"]["not_found"]; + }; + }; + "private-registries/create-org-private-registry": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** + * @description The registry type. + * @enum {string} + */ + registry_type: "maven_repository"; + /** @description The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication. */ + username?: string | null; + /** @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint. */ + encrypted_value: string; + /** @description The ID of the key you used to encrypt the secret. */ + key_id: string; + /** + * @description Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry. + * @enum {string} + */ + visibility: "all" | "private" | "selected"; + /** @description An array of repository IDs that can access the organization private registry. You can only provide a list of repository IDs when `visibility` is set to `selected`. You can manage the list of selected repositories using the [Update a private registry for an organization](https://docs.github.com/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization) endpoint. This field should be omitted if `visibility` is set to `all` or `private`. */ + selected_repository_ids?: number[]; + }; + }; + }; + responses: { + /** @description The organization private registry configuration */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["org-private-registry-configuration-with-selected-repositories"]; + }; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "private-registries/get-org-public-key": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * @description The identifier for the key. + * @example 012345678912345678 + */ + key_id: string; + /** + * @description The Base64 encoded public key. + * @example 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 + */ + key: string; + }; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + "private-registries/get-org-private-registry": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The name of the secret. */ + secret_name: components["parameters"]["secret-name"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description The specified private registry configuration for the organization */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["org-private-registry-configuration"]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + "private-registries/delete-org-private-registry": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The name of the secret. */ + secret_name: components["parameters"]["secret-name"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 400: components["responses"]["bad_request"]; + 404: components["responses"]["not_found"]; + }; + }; + "private-registries/update-org-private-registry": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The name of the secret. */ + secret_name: components["parameters"]["secret-name"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** + * @description The registry type. + * @enum {string} + */ + registry_type?: "maven_repository"; + /** @description The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication. */ + username?: string | null; + /** @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint. */ + encrypted_value?: string; + /** @description The ID of the key you used to encrypt the secret. */ + key_id?: string; + /** + * @description Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry. + * @enum {string} + */ + visibility?: "all" | "private" | "selected"; + /** @description An array of repository IDs that can access the organization private registry. You can only provide a list of repository IDs when `visibility` is set to `selected`. This field should be omitted if `visibility` is set to `all` or `private`. */ + selected_repository_ids?: number[]; + }; + }; + }; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; "projects/list-for-org": { parameters: { query?: { @@ -95682,23 +96955,7 @@ export interface operations { }; requestBody: { content: { - "application/json": { - /** - * @description The type of the value for the property - * @example single_select - * @enum {string} - */ - value_type: "string" | "single_select" | "multi_select" | "true_false"; - /** @description Whether the property is required. */ - required?: boolean; - /** @description Default value of the property */ - default_value?: (string | string[]) | null; - /** @description Short description of the property */ - description?: string | null; - /** @description An ordered list of the allowed values of the property. - * The property can have up to 200 allowed values. */ - allowed_values?: string[] | null; - }; + "application/json": components["schemas"]["custom-property-set-payload"]; }; }; responses: { @@ -96155,7 +97412,7 @@ export interface operations { * @default branch * @enum {string} */ - target?: "branch" | "tag" | "push"; + target?: "branch" | "tag" | "push" | "repository"; enforcement: components["schemas"]["repository-rule-enforcement"]; /** @description The actors that can bypass the rules in this ruleset */ bypass_actors?: components["schemas"]["repository-ruleset-bypass-actor"][]; @@ -96184,7 +97441,7 @@ export interface operations { query?: { /** @description The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. */ ref?: components["parameters"]["ref-in-query"]; - /** @description The name of the repository to filter on. When specified, only rule evaluations from this repository will be returned. */ + /** @description The name of the repository to filter on. */ repository_name?: components["parameters"]["repository-name-in-query"]; /** @description The time period to filter by. * @@ -96300,7 +97557,7 @@ export interface operations { * @description The target of the ruleset * @enum {string} */ - target?: "branch" | "tag" | "push"; + target?: "branch" | "tag" | "push" | "repository"; enforcement?: components["schemas"]["repository-rule-enforcement"]; /** @description The actors that can bypass the rules in this ruleset */ bypass_actors?: components["schemas"]["repository-ruleset-bypass-actor"][]; @@ -96354,9 +97611,7 @@ export interface operations { query?: { /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ state?: components["parameters"]["secret-scanning-alert-state"]; - /** @description A comma-separated list of secret types to return. By default all secret types are returned. - * See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" - * for a complete list of secret types. */ + /** @description A comma-separated list of secret types to return. All default secret patterns are returned. To return experimental patterns, pass the token name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. */ secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ resolution?: components["parameters"]["secret-scanning-alert-resolution"]; @@ -101375,6 +102630,7 @@ export interface operations { }; }; repository_id?: number; + bundle_url?: string; }[]; }; }; @@ -103463,6 +104719,126 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; + "code-scanning/get-autofix": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The account owner of the repository. The name is not case sensitive. */ + owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ + repo: components["parameters"]["repo"]; + /** @description The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */ + alert_number: components["parameters"]["alert-number"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["code-scanning-autofix"]; + }; + }; + 400: components["responses"]["code_scanning_bad_request"]; + 403: components["responses"]["code_scanning_forbidden_read"]; + 404: components["responses"]["not_found"]; + 503: components["responses"]["service_unavailable"]; + }; + }; + "code-scanning/create-autofix": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The account owner of the repository. The name is not case sensitive. */ + owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ + repo: components["parameters"]["repo"]; + /** @description The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */ + alert_number: components["parameters"]["alert-number"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["code-scanning-autofix"]; + }; + }; + /** @description Accepted */ + 202: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["code-scanning-autofix"]; + }; + }; + 400: components["responses"]["code_scanning_bad_request"]; + 403: components["responses"]["code_scanning_autofix_create_forbidden"]; + 404: components["responses"]["not_found"]; + /** @description Unprocessable Entity */ + 422: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 503: components["responses"]["service_unavailable"]; + }; + }; + "code-scanning/commit-autofix": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The account owner of the repository. The name is not case sensitive. */ + owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ + repo: components["parameters"]["repo"]; + /** @description The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */ + alert_number: components["parameters"]["alert-number"]; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": components["schemas"]["code-scanning-autofix-commits"]; + }; + }; + responses: { + /** @description Created */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["code-scanning-autofix-commits-response"]; + }; + }; + 400: components["responses"]["code_scanning_bad_request"]; + 403: components["responses"]["code_scanning_forbidden_write"]; + 404: components["responses"]["not_found"]; + /** @description Unprocessable Entity */ + 422: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 503: components["responses"]["service_unavailable"]; + }; + }; "code-scanning/list-alert-instances": { parameters: { query?: { @@ -109679,6 +111055,163 @@ export interface operations { }; }; }; + "issues/remove-sub-issue": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The account owner of the repository. The name is not case sensitive. */ + owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ + repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ + issue_number: components["parameters"]["issue-number"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description The sub-issue to remove */ + sub_issue_id: number; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + /** @example https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue */ + Location?: string; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["issue"]; + }; + }; + 400: components["responses"]["bad_request"]; + 404: components["responses"]["not_found"]; + }; + }; + "issues/list-sub-issues": { + parameters: { + query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + page?: components["parameters"]["page"]; + }; + header?: never; + path: { + /** @description The account owner of the repository. The name is not case sensitive. */ + owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ + repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ + issue_number: components["parameters"]["issue-number"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["issue"][]; + }; + }; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; + }; + }; + "issues/add-sub-issue": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The account owner of the repository. The name is not case sensitive. */ + owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ + repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ + issue_number: components["parameters"]["issue-number"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description The sub-issue to add */ + sub_issue_id: number; + /** @description Option that, when true, instructs the operation to replace the sub-issues current parent issue */ + replace_parent?: boolean; + }; + }; + }; + responses: { + /** @description Response */ + 201: { + headers: { + /** @example https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1 */ + Location?: string; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["issue"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "issues/reprioritize-sub-issue": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The account owner of the repository. The name is not case sensitive. */ + owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ + repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ + issue_number: components["parameters"]["issue-number"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description The id of the sub-issue to reprioritize */ + sub_issue_id: number; + /** @description The id of the sub-issue to be prioritized after (either positional argument after OR before should be specified). */ + after_id?: number; + /** @description The id of the sub-issue to be prioritized before (either positional argument after OR before should be specified). */ + before_id?: number; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["issue"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed_simple"]; + 503: components["responses"]["service_unavailable"]; + }; + }; "issues/list-events-for-timeline": { parameters: { query?: { @@ -113291,9 +114824,7 @@ export interface operations { query?: { /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ state?: components["parameters"]["secret-scanning-alert-state"]; - /** @description A comma-separated list of secret types to return. By default all secret types are returned. - * See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" - * for a complete list of secret types. */ + /** @description A comma-separated list of secret types to return. All default secret patterns are returned. To return experimental patterns, pass the token name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. */ secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ resolution?: components["parameters"]["secret-scanning-alert-resolution"]; @@ -113534,6 +115065,39 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; + "secret-scanning/get-scan-history": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The account owner of the repository. The name is not case sensitive. */ + owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ + repo: components["parameters"]["repo"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["secret-scanning-scan-history"]; + }; + }; + /** @description Repository does not have GitHub Advanced Security or secret scanning enabled */ + 404: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 503: components["responses"]["service_unavailable"]; + }; + }; "security-advisories/list-repository-advisories": { parameters: { query?: { @@ -119189,6 +120753,7 @@ export interface operations { attestations?: { bundle?: components["schemas"]["sigstore-bundle-0"]; repository_id?: number; + bundle_url?: string; }[]; }; }; diff --git a/packages/openapi-typescript/examples/github-api.yaml b/packages/openapi-typescript/examples/github-api.yaml index 203a43624..1724d88ad 100644 --- a/packages/openapi-typescript/examples/github-api.yaml +++ b/packages/openapi-typescript/examples/github-api.yaml @@ -730,8 +730,6 @@ paths: Optionally, use the `permissions` body parameter to specify the permissions that the installation access token should have. If `permissions` is not specified, the installation access token will have all of the permissions that were granted to the app. The installation access token cannot be granted permissions that the app was not granted. - When using the repository or permission parameters to reduce the access of the token, the complexity of the token is increased due to both the number of permissions in the request and the number of repositories the token will have access to. If the complexity is too large, the token will fail to be issued. If this occurs, the error message will indicate the maximum number of repositories that should be requested. For the average application requesting 8 permissions, this limit is around 5000 repositories. With fewer permissions requested, more repositories are supported. - You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. tags: - apps @@ -1429,200 +1427,660 @@ paths: enabledForGitHubApps: true category: emojis subcategory: emojis - "/enterprises/{enterprise}/copilot/billing/seats": + "/enterprises/{enterprise}/code-security/configurations": get: - summary: List all Copilot seat assignments for an enterprise + summary: Get code security configurations for an enterprise description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Lists all Copilot seats currently being billed for across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription. - - Users with access through multiple organizations or enterprise teams will only be counted toward `total_seats` once. - - For each organization or enterprise team which grants Copilot access to a user, a seat detail object will appear in the `seats` array. - Each seat object contains information about the assigned user's most recent Copilot activity. Users must have - telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. For more information about activity data, - see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." + Lists all code security configurations available in an enterprise. - Only enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams. + The authenticated user must be an administrator of the enterprise in order to use this endpoint. - Personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. tags: - - copilot - operationId: copilot/list-copilot-seats-for-enterprise + - code-security + operationId: code-security/get-configurations-for-enterprise externalDocs: description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-user-management#list-all-copilot-seat-assignments-for-an-enterprise + url: https://docs.github.com/rest/code-security/configurations#get-code-security-configurations-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" - - "$ref": "#/components/parameters/page" - name: per_page + in: query description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." - in: query + required: false schema: type: integer - default: 50 + default: 30 + - "$ref": "#/components/parameters/pagination-before" + - "$ref": "#/components/parameters/pagination-after" responses: '200': description: Response content: application/json: schema: - type: object - properties: - total_seats: - type: integer - description: The total number of Copilot seats the enterprise - is being billed for. Users with access through multiple organizations - or enterprise teams are only counted once. - seats: - type: array - items: - "$ref": "#/components/schemas/copilot-seat-details" + type: array + items: + "$ref": "#/components/schemas/code-security-configuration" examples: default: - "$ref": "#/components/examples/copilot-seats-list" - headers: - Link: - "$ref": "#/components/headers/link" - '500': - "$ref": "#/components/responses/internal_error" - '401': - "$ref": "#/components/responses/requires_authentication" + "$ref": "#/components/examples/enterprise-code-security-configuration-list" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: code-security + subcategory: configurations + post: + summary: Create a code security configuration for an enterprise + description: |- + Creates a code security configuration in an enterprise. + + The authenticated user must be an administrator of the enterprise in order to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + tags: + - code-security + operationId: code-security/create-configuration-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/code-security/configurations#create-a-code-security-configuration-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + requestBody: + required: true + content: + application/json: + schema: + type: object + additionalProperties: false + properties: + name: + type: string + description: The name of the code security configuration. Must be + unique within the enterprise. + description: + type: string + description: A description of the code security configuration + maxLength: 255 + advanced_security: + type: string + description: The enablement status of GitHub Advanced Security + enum: + - enabled + - disabled + default: disabled + dependency_graph: + type: string + description: The enablement status of Dependency Graph + enum: + - enabled + - disabled + - not_set + default: enabled + dependency_graph_autosubmit_action: + type: string + description: The enablement status of Automatic dependency submission + enum: + - enabled + - disabled + - not_set + default: disabled + dependency_graph_autosubmit_action_options: + type: object + description: Feature options for Automatic dependency submission + properties: + labeled_runners: + type: boolean + description: Whether to use runners labeled with 'dependency-submission' + or standard GitHub runners. + default: false + dependabot_alerts: + type: string + description: The enablement status of Dependabot alerts + enum: + - enabled + - disabled + - not_set + default: disabled + dependabot_security_updates: + type: string + description: The enablement status of Dependabot security updates + enum: + - enabled + - disabled + - not_set + default: disabled + code_scanning_default_setup: + type: string + description: The enablement status of code scanning default setup + enum: + - enabled + - disabled + - not_set + default: disabled + code_scanning_default_setup_options: + "$ref": "#/components/schemas/code-scanning-default-setup-options" + secret_scanning: + type: string + description: The enablement status of secret scanning + enum: + - enabled + - disabled + - not_set + default: disabled + secret_scanning_push_protection: + type: string + description: The enablement status of secret scanning push protection + enum: + - enabled + - disabled + - not_set + default: disabled + secret_scanning_validity_checks: + type: string + description: The enablement status of secret scanning validity checks + enum: + - enabled + - disabled + - not_set + default: disabled + secret_scanning_non_provider_patterns: + type: string + description: The enablement status of secret scanning non provider + patterns + enum: + - enabled + - disabled + - not_set + default: disabled + private_vulnerability_reporting: + type: string + description: The enablement status of private vulnerability reporting + enum: + - enabled + - disabled + - not_set + default: disabled + enforcement: + type: string + description: The enforcement status for a security configuration + enum: + - enforced + - unenforced + default: enforced + required: + - name + - description + examples: + default: + summary: Example for a code security configuration + value: + name: High rish settings + description: This is a code security configuration for octo-enterprise + advanced_security: enabled + dependabot_alerts: enabled + dependabot_security_updates: not_set + secret_scanning: enabled + responses: + '201': + description: Successfully created code security configuration + content: + application/json: + schema: + "$ref": "#/components/schemas/code-security-configuration" + examples: + default: + "$ref": "#/components/examples/enterprise-code-security-configuration" + '400': + "$ref": "#/components/responses/bad_request" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: code-security + subcategory: configurations + "/enterprises/{enterprise}/code-security/configurations/defaults": + get: + summary: Get default code security configurations for an enterprise + description: |- + Lists the default code security configurations for an enterprise. + + The authenticated user must be an administrator of the enterprise in order to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. + tags: + - code-security + operationId: code-security/get-default-configurations-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/code-security/configurations#get-default-code-security-configurations-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/code-security-default-configurations" + examples: + default: + "$ref": "#/components/examples/code-security-default-configurations" x-github: githubCloudOnly: false enabledForGitHubApps: true - category: copilot - subcategory: copilot-user-management - "/enterprises/{enterprise}/copilot/metrics": + category: code-security + subcategory: configurations + "/enterprises/{enterprise}/code-security/configurations/{configuration_id}": get: - summary: Get Copilot metrics for an enterprise + summary: Retrieve a code security configuration of an enterprise description: |- - Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. + Gets a code security configuration available in an enterprise. - The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, - and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, - they must have telemetry enabled in their IDE. + The authenticated user must be an administrator of the enterprise in order to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. + tags: + - code-security + operationId: code-security/get-single-configuration-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/code-security/configurations#retrieve-a-code-security-configuration-of-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/configuration-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/code-security-configuration" + examples: + default: + "$ref": "#/components/examples/enterprise-code-security-configuration" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: code-security + subcategory: configurations + patch: + summary: Update a custom code security configuration for an enterprise + description: |- + Updates a code security configuration in an enterprise. - To access this endpoint, the Copilot Metrics API access policy must be enabled or set to "no policy" for the enterprise within GitHub settings. - Only enterprise owners and billing managers can view Copilot metrics for the enterprise. + The authenticated user must be an administrator of the enterprise in order to use this endpoint. - OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. tags: - - copilot - operationId: copilot/copilot-metrics-for-enterprise + - code-security + operationId: code-security/update-enterprise-configuration externalDocs: description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-enterprise + url: https://docs.github.com/rest/code-security/configurations#update-a-custom-code-security-configuration-for-an-enterprise parameters: - "$ref": "#/components/parameters/enterprise" - - name: since - description: Show usage metrics since this date. This is a timestamp in [ISO - 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). - Maximum value is 28 days ago. - in: query - required: false - schema: - type: string - - name: until - description: Show usage metrics until this date. This is a timestamp in [ISO - 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) - and should not preceed the `since` date if it is passed. - in: query - required: false - schema: - type: string - - "$ref": "#/components/parameters/page" - - name: per_page - description: The number of days of metrics to display per page (max 28). For - more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." - in: query - schema: - type: integer - default: 28 + - "$ref": "#/components/parameters/configuration-id" + requestBody: + required: true + content: + application/json: + schema: + type: object + additionalProperties: false + properties: + name: + type: string + description: The name of the code security configuration. Must be + unique across the enterprise. + description: + type: string + description: A description of the code security configuration + maxLength: 255 + advanced_security: + type: string + description: The enablement status of GitHub Advanced Security. + Must be set to enabled if you want to enable any GHAS settings. + enum: + - enabled + - disabled + dependency_graph: + type: string + description: The enablement status of Dependency Graph + enum: + - enabled + - disabled + - not_set + dependency_graph_autosubmit_action: + type: string + description: The enablement status of Automatic dependency submission + enum: + - enabled + - disabled + - not_set + dependency_graph_autosubmit_action_options: + type: object + description: Feature options for Automatic dependency submission + properties: + labeled_runners: + type: boolean + description: Whether to use runners labeled with 'dependency-submission' + or standard GitHub runners. + dependabot_alerts: + type: string + description: The enablement status of Dependabot alerts + enum: + - enabled + - disabled + - not_set + dependabot_security_updates: + type: string + description: The enablement status of Dependabot security updates + enum: + - enabled + - disabled + - not_set + code_scanning_default_setup: + type: string + description: The enablement status of code scanning default setup + enum: + - enabled + - disabled + - not_set + code_scanning_default_setup_options: + "$ref": "#/components/schemas/code-scanning-default-setup-options" + secret_scanning: + type: string + description: The enablement status of secret scanning + enum: + - enabled + - disabled + - not_set + secret_scanning_push_protection: + type: string + description: The enablement status of secret scanning push protection + enum: + - enabled + - disabled + - not_set + secret_scanning_validity_checks: + type: string + description: The enablement status of secret scanning validity checks + enum: + - enabled + - disabled + - not_set + secret_scanning_non_provider_patterns: + type: string + description: The enablement status of secret scanning non-provider + patterns + enum: + - enabled + - disabled + - not_set + private_vulnerability_reporting: + type: string + description: The enablement status of private vulnerability reporting + enum: + - enabled + - disabled + - not_set + enforcement: + type: string + description: The enforcement status for a security configuration + enum: + - enforced + - unenforced + examples: + default: + summary: Example for updating a code security configuration + value: + name: octo-enterprise recommended settings v2 + secret_scanning: disabled + code_scanning_default_setup: enabled responses: '200': description: Response content: application/json: schema: - type: array - items: - "$ref": "#/components/schemas/copilot-usage-metrics-day" + "$ref": "#/components/schemas/code-security-configuration" examples: default: - "$ref": "#/components/examples/copilot-usage-metrics-for-day" - '500': - "$ref": "#/components/responses/internal_error" + "$ref": "#/components/examples/enterprise-code-security-configuration" + '304': + "$ref": "#/components/responses/not_modified" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" - '422': - "$ref": "#/components/responses/usage_metrics_api_disabled" + '409': + "$ref": "#/components/responses/conflict" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: code-security + subcategory: configurations + delete: + summary: Delete a code security configuration for an enterprise + description: |- + Deletes a code security configuration from an enterprise. + Repositories attached to the configuration will retain their settings but will no longer be associated with + the configuration. + + The authenticated user must be an administrator for the enterprise to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + tags: + - code-security + operationId: code-security/delete-configuration-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/code-security/configurations#delete-a-code-security-configuration-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/configuration-id" + responses: + '204': + "$ref": "#/components/responses/no_content" + '400': + "$ref": "#/components/responses/bad_request" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '409': + "$ref": "#/components/responses/conflict" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: code-security + subcategory: configurations + "/enterprises/{enterprise}/code-security/configurations/{configuration_id}/attach": + post: + summary: Attach an enterprise configuration to repositories + description: |- + Attaches an enterprise code security configuration to repositories. If the repositories specified are already attached to a configuration, they will be re-attached to the provided configuration. + + If insufficient GHAS licenses are available to attach the configuration to a repository, only free features will be enabled. + + The authenticated user must be an administrator for the enterprise to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + tags: + - code-security + operationId: code-security/attach-enterprise-configuration + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/code-security/configurations#attach-an-enterprise-configuration-to-repositories + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/configuration-id" + requestBody: + required: true + content: + application/json: + schema: + type: object + additionalProperties: false + properties: + scope: + type: string + description: The type of repositories to attach the configuration + to. `selected` means the configuration will be attached to only + the repositories specified by `selected_repository_ids` + enum: + - all + - all_without_configurations + required: + - scope + examples: + default: + summary: Example for attaching a configuration to some repositories + value: + scope: all + responses: + '202': + "$ref": "#/components/responses/accepted" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '409': + "$ref": "#/components/responses/conflict" x-github: githubCloudOnly: false enabledForGitHubApps: true - category: copilot - subcategory: copilot-metrics - "/enterprises/{enterprise}/copilot/usage": - get: - summary: Get a summary of Copilot usage for enterprise members + category: code-security + subcategory: configurations + "/enterprises/{enterprise}/code-security/configurations/{configuration_id}/defaults": + put: + summary: Set a code security configuration as a default for an enterprise description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. + Sets a code security configuration as a default to be applied to new repositories in your enterprise. - You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE - for all users across organizations with access to Copilot within your enterprise, with a further breakdown of suggestions, acceptances, - and number of active users by editor and language for each day. See the response schema tab for detailed metrics definitions. + This configuration will be applied by default to the matching repository type when created, but only for organizations within the enterprise that do not already have a default code security configuration set. - The response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day, - and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, - they must have telemetry enabled in their IDE. + The authenticated user must be an administrator for the enterprise to use this endpoint. - The time zone in the response is in UTC time, that means that the cutoff time for the "day" is UTC time. + OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + tags: + - code-security + operationId: code-security/set-configuration-as-default-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/configuration-id" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + default_for_new_repos: + type: string + description: Specify which types of repository this security configuration + should be applied to by default. + enum: + - all + - none + - private_and_internal + - public + examples: + default: + summary: Set this configuration to be enabled by default on all new + repositories. + value: + default_for_new_repos: all + responses: + '200': + description: Default successfully changed. + content: + application/json: + schema: + type: object + properties: + default_for_new_repos: + type: string + description: Specifies which types of repository this security + configuration is applied to by default. + enum: + - all + - none + - private_and_internal + - public + configuration: + "$ref": "#/components/schemas/code-security-configuration" + examples: + default: + value: + default_for_new_repos: all + configuration: + "$ref": "#/components/examples/code-security-configuration" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: code-security + subcategory: configurations + "/enterprises/{enterprise}/code-security/configurations/{configuration_id}/repositories": + get: + summary: Get repositories associated with an enterprise code security configuration + description: |- + Lists the repositories associated with an enterprise code security configuration in an organization. - Only owners and billing managers can view Copilot usage metrics for the enterprise. + The authenticated user must be an administrator of the enterprise in order to use this endpoint. - OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. tags: - - copilot - operationId: copilot/usage-metrics-for-enterprise + - code-security + operationId: code-security/get-repositories-for-enterprise-configuration externalDocs: description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-usage#get-a-summary-of-copilot-usage-for-enterprise-members + url: https://docs.github.com/rest/code-security/configurations#get-repositories-associated-with-an-enterprise-code-security-configuration parameters: - "$ref": "#/components/parameters/enterprise" - - name: since - description: Show usage metrics since this date. This is a timestamp in [ISO - 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). - Maximum value is 28 days ago. + - "$ref": "#/components/parameters/configuration-id" + - name: per_page + description: The number of results per page (max 100). For more information, + see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." in: query required: false schema: - type: string - - name: until - description: Show usage metrics until this date. This is a timestamp in [ISO - 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) - and should not preceed the `since` date if it is passed. + type: integer + default: 30 + - "$ref": "#/components/parameters/pagination-before" + - "$ref": "#/components/parameters/pagination-after" + - name: status + description: |- + A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned. + + Can be: `all`, `attached`, `attaching`, `removed`, `enforced`, `failed`, `updating`, `removed_by_enterprise` in: query required: false schema: type: string - - "$ref": "#/components/parameters/page" - - name: per_page - description: The number of days of metrics to display per page (max 28). For - more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." - in: query - schema: - type: integer - default: 28 + default: all responses: '200': description: Response @@ -1631,23 +2089,23 @@ paths: schema: type: array items: - "$ref": "#/components/schemas/copilot-usage-metrics" + "$ref": "#/components/schemas/code-security-configuration-repositories" examples: default: - "$ref": "#/components/examples/copilot-usage-metrics-enterprise" - '500': - "$ref": "#/components/responses/internal_error" - '401': - "$ref": "#/components/responses/requires_authentication" + summary: Example of code security configuration repositories + value: + - status: attached + repository: + "$ref": "#/components/examples/simple-repository" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false - enabledForGitHubApps: true - category: copilot - subcategory: copilot-usage + enabledForGitHubApps: false + category: code-security + subcategory: configurations "/enterprises/{enterprise}/dependabot/alerts": get: summary: List Dependabot alerts for an enterprise @@ -1759,160 +2217,6 @@ paths: enabledForGitHubApps: false category: secret-scanning subcategory: secret-scanning - "/enterprises/{enterprise}/team/{team_slug}/copilot/metrics": - get: - summary: Get Copilot metrics for an enterprise team - description: |- - Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. - - The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, - and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, - they must have telemetry enabled in their IDE. - - > [!NOTE] - > This endpoint will only return results for a given day if the enterprise team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day. - - To access this endpoint, the Copilot Metrics API access policy must be enabled or set to "no policy" for the enterprise within GitHub settings. - Only owners and billing managers for the enterprise that contains the enterprise team can view Copilot metrics for the enterprise team. - - OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. - tags: - - copilot - operationId: copilot/copilot-metrics-for-enterprise-team - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-enterprise-team - parameters: - - "$ref": "#/components/parameters/enterprise" - - "$ref": "#/components/parameters/enterprise-team-slug" - - name: since - description: Show usage metrics since this date. This is a timestamp in [ISO - 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). - Maximum value is 28 days ago. - in: query - required: false - schema: - type: string - - name: until - description: Show usage metrics until this date. This is a timestamp in [ISO - 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) - and should not preceed the `since` date if it is passed. - in: query - required: false - schema: - type: string - - "$ref": "#/components/parameters/page" - - name: per_page - description: The number of days of metrics to display per page (max 28). For - more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." - in: query - schema: - type: integer - default: 28 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - "$ref": "#/components/schemas/copilot-usage-metrics-day" - examples: - default: - "$ref": "#/components/examples/copilot-usage-metrics-for-day" - '500': - "$ref": "#/components/responses/internal_error" - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - '422': - "$ref": "#/components/responses/usage_metrics_api_disabled" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: copilot - subcategory: copilot-metrics - "/enterprises/{enterprise}/team/{team_slug}/copilot/usage": - get: - summary: Get a summary of Copilot usage for an enterprise team - description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE - for users within an enterprise team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day. - See the response schema tab for detailed metrics definitions. - - The response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day, - and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, - they must have telemetry enabled in their IDE. - - > [!NOTE] - > This endpoint will only return results for a given day if the enterprise team had five or more members with active Copilot licenses, as evaluated at the end of that day. - - Owners and billing managers for the enterprise that contains the enterprise team can view Copilot usage metrics for the enterprise team. - - OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. - tags: - - copilot - operationId: copilot/usage-metrics-for-enterprise-team - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-usage#get-a-summary-of-copilot-usage-for-an-enterprise-team - parameters: - - "$ref": "#/components/parameters/enterprise" - - "$ref": "#/components/parameters/team-slug" - - name: since - description: Show usage metrics since this date. This is a timestamp in [ISO - 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). - Maximum value is 28 days ago. - in: query - required: false - schema: - type: string - - name: until - description: Show usage metrics until this date. This is a timestamp in [ISO - 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) - and should not preceed the `since` date if it is passed. - in: query - required: false - schema: - type: string - - "$ref": "#/components/parameters/page" - - name: per_page - description: The number of days of metrics to display per page (max 28). For - more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." - in: query - schema: - type: integer - default: 28 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - "$ref": "#/components/schemas/copilot-usage-metrics" - examples: - default: - "$ref": "#/components/examples/copilot-usage-metrics-org" - '500': - "$ref": "#/components/responses/internal_error" - '401': - "$ref": "#/components/responses/requires_authentication" - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: copilot - subcategory: copilot-usage "/events": get: summary: List public events @@ -4019,6 +4323,41 @@ paths: enabledForGitHubApps: true category: orgs subcategory: orgs + "/organizations/{org}/settings/billing/usage": + get: + summary: Get billing usage report for an organization + description: |- + Gets a report of the total usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account. + + **Note:** This endpoint is only available to organizations with access to the enhanced billing platform. For more information, see "[About the enhanced billing platform](https://docs.github.com/billing/using-the-new-billing-platform)." + tags: + - billing + operationId: billing/get-github-billing-usage-report-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/billing/enhanced-billing#get-billing-usage-report-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/billing-usage-report-year" + - "$ref": "#/components/parameters/billing-usage-report-month" + - "$ref": "#/components/parameters/billing-usage-report-day" + - "$ref": "#/components/parameters/billing-usage-report-hour" + responses: + '200': + "$ref": "#/components/responses/billing_usage_report_org" + '400': + "$ref": "#/components/responses/bad_request" + '403': + "$ref": "#/components/responses/forbidden" + '500': + "$ref": "#/components/responses/internal_error" + '503': + "$ref": "#/components/responses/service_unavailable" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: billing + subcategory: enhanced-billing "/orgs/{org}": get: summary: Get an organization @@ -6706,6 +7045,8 @@ paths: Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information. repository_id: type: integer + bundle_url: + type: string examples: default: "$ref": "#/components/examples/list-attestations" @@ -7035,6 +7376,8 @@ paths: - disabled - not_set default: disabled + code_scanning_default_setup_options: + "$ref": "#/components/schemas/code-scanning-default-setup-options" secret_scanning: type: string description: The enablement status of secret scanning @@ -7358,6 +7701,8 @@ paths: - enabled - disabled - not_set + code_scanning_default_setup_options: + "$ref": "#/components/schemas/code-scanning-default-setup-options" secret_scanning: type: string description: The enablement status of secret scanning @@ -8443,13 +8788,11 @@ paths: Purchases a GitHub Copilot seat for all users within each specified team. The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." - Only organization owners can add Copilot seats for their organization members. - - In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy. + Only organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy. For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." - The response will contain the total number of new seats that were created and existing seats that were refreshed. + The response contains the total number of new seats that were created and existing seats that were refreshed. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: @@ -8527,14 +8870,11 @@ paths: Sets seats for all members of each team specified to "pending cancellation". This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team. - - For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." - - For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." + For more information about disabling access to Copilot, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." Only organization owners can cancel Copilot seats for their organization members. - The response will contain the total number of seats set to "pending cancellation". + The response contains the total number of seats set to "pending cancellation". OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: @@ -8614,13 +8954,11 @@ paths: Purchases a GitHub Copilot seat for each user specified. The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." - Only organization owners can add Copilot seats for their organization members. - - In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy. + Only organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy. For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." - The response will contain the total number of new seats that were created and existing seats that were refreshed. + The response contains the total number of new seats that were created and existing seats that were refreshed. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: @@ -8697,14 +9035,11 @@ paths: Sets seats for all users specified to "pending cancellation". This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership. - - For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." - - For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." + For more information about disabling access to Copilot, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." Only organization owners can cancel Copilot seats for their organization members. - The response will contain the total number of seats set to "pending cancellation". + The response contains the total number of seats set to "pending cancellation". OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. tags: @@ -9463,7 +9798,9 @@ paths: get: summary: List organization webhooks description: |- - You must be an organization owner to use this endpoint. + List webhooks for an organization. + + The authenticated user must be an organization owner to use this endpoint. OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. @@ -9722,7 +10059,9 @@ paths: delete: summary: Delete an organization webhook description: |- - You must be an organization owner to use this endpoint. + Delete a webhook for an organization. + + The authenticated user must be an organization owner to use this endpoint. OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. @@ -9999,6 +10338,7 @@ paths: - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/direction" - "$ref": "#/components/parameters/api-insights-route-stats-sort" + - "$ref": "#/components/parameters/api-insights-api-route-substring" responses: '200': description: Response @@ -10032,6 +10372,7 @@ paths: - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/direction" - "$ref": "#/components/parameters/api-insights-sort" + - "$ref": "#/components/parameters/api-insights-subject-name-substring" responses: '200': description: Response @@ -10250,6 +10591,7 @@ paths: - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/direction" - "$ref": "#/components/parameters/api-insights-sort" + - "$ref": "#/components/parameters/api-insights-actor-name-substring" responses: '200': description: Response @@ -12766,6 +13108,377 @@ paths: enabledForGitHubApps: true category: orgs subcategory: personal-access-tokens + "/orgs/{org}/private-registries": + get: + summary: List private registries for an organization + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Lists all private registry configurations available at the organization-level without revealing their encrypted + values. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - private-registries + operationId: private-registries/list-org-private-registries + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/private-registries/organization-configurations#list-private-registries-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - configurations + properties: + total_count: + type: integer + configurations: + type: array + items: + "$ref": "#/components/schemas/org-private-registry-configuration" + examples: + default: + "$ref": "#/components/examples/org-private-registry-configurations-paginated" + headers: + Link: + "$ref": "#/components/headers/link" + '400': + "$ref": "#/components/responses/bad_request" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: private-registries + subcategory: organization-configurations + post: + summary: Create a private registry for an organization + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Creates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - private-registries + operationId: private-registries/create-org-private-registry + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/private-registries/organization-configurations#create-a-private-registry-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + registry_type: + description: The registry type. + type: string + enum: + - maven_repository + username: + description: The username to use when authenticating with the private + registry. This field should be omitted if the private registry + does not require a username for authentication. + type: string + nullable: true + encrypted_value: + description: The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) + using the public key retrieved from the [Get private registries + public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) + endpoint. + type: string + pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" + key_id: + description: The ID of the key you used to encrypt the secret. + type: string + visibility: + description: Which type of organization repositories have access + to the private registry. `selected` means only the repositories + specified by `selected_repository_ids` can access the private + registry. + type: string + enum: + - all + - private + - selected + selected_repository_ids: + description: An array of repository IDs that can access the organization + private registry. You can only provide a list of repository IDs + when `visibility` is set to `selected`. You can manage the list + of selected repositories using the [Update a private registry + for an organization](https://docs.github.com/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization) + endpoint. This field should be omitted if `visibility` is set + to `all` or `private`. + type: array + items: + type: integer + required: + - registry_type + - encrypted_value + - key_id + - visibility + examples: + org-private-registry-with-private-visibility: + summary: Example of a private registry configuration with private + visibility + value: + registry_type: maven_repository + username: monalisa + encrypted_value: c2VjcmV0 + key_id: '012345678912345678' + visibility: private + org-private-registry-with-selected-visibility: + summary: Example of a private registry configuration with selected + visibility + value: + registry_type: maven_repository + username: monalisa + encrypted_value: c2VjcmV0 + key_id: '012345678912345678' + visibility: selected + selected_repository_ids: + - 1296269 + - 1296280 + responses: + '201': + description: The organization private registry configuration + content: + application/json: + schema: + "$ref": "#/components/schemas/org-private-registry-configuration-with-selected-repositories" + examples: + org-private-registry-with-selected-visibility: + "$ref": "#/components/examples/org-private-registry-configuration" + org-private-registry-with-private-visibility: + "$ref": "#/components/examples/org-private-registry-configuration-with-selected-repositories" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: private-registries + subcategory: organization-configurations + "/orgs/{org}/private-registries/public-key": + get: + summary: Get private registries public key for an organization + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Gets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets. + + OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - private-registries + operationId: private-registries/get-org-public-key + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - key_id + - key + properties: + key_id: + description: The identifier for the key. + example: '012345678912345678' + type: string + key: + description: The Base64 encoded public key. + example: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 + type: string + examples: + default: + "$ref": "#/components/examples/private-registries-public-key" + headers: + Link: + "$ref": "#/components/headers/link" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: private-registries + subcategory: organization-configurations + "/orgs/{org}/private-registries/{secret_name}": + get: + summary: Get a private registry for an organization + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Get the configuration of a single private registry defined for an organization, omitting its encrypted value. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - private-registries + operationId: private-registries/get-org-private-registry + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/private-registries/organization-configurations#get-a-private-registry-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/secret-name" + responses: + '200': + description: The specified private registry configuration for the organization + content: + application/json: + schema: + "$ref": "#/components/schemas/org-private-registry-configuration" + examples: + default: + "$ref": "#/components/examples/org-private-registry-configuration" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: private-registries + subcategory: organization-configurations + patch: + summary: Update a private registry for an organization + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - private-registries + operationId: private-registries/update-org-private-registry + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/secret-name" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + registry_type: + description: The registry type. + type: string + enum: + - maven_repository + username: + description: The username to use when authenticating with the private + registry. This field should be omitted if the private registry + does not require a username for authentication. + type: string + nullable: true + encrypted_value: + description: The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) + using the public key retrieved from the [Get private registries + public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) + endpoint. + type: string + pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" + key_id: + description: The ID of the key you used to encrypt the secret. + type: string + visibility: + description: Which type of organization repositories have access + to the private registry. `selected` means only the repositories + specified by `selected_repository_ids` can access the private + registry. + type: string + enum: + - all + - private + - selected + selected_repository_ids: + description: An array of repository IDs that can access the organization + private registry. You can only provide a list of repository IDs + when `visibility` is set to `selected`. This field should be omitted + if `visibility` is set to `all` or `private`. + type: array + items: + type: integer + examples: + update-username-and-encrypted-value: + value: + username: monalisa + encrypted_value: c2VjcmV0 + key_id: '012345678912345678' + update-with-selected-visibility: + value: + visibility: selected + selected_repository_ids: + - 1296269 + - 1296280 + responses: + '204': + description: Response + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: private-registries + subcategory: organization-configurations + delete: + summary: Delete a private registry for an organization + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Delete a private registry configuration at the organization-level. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - private-registries + operationId: private-registries/delete-org-private-registry + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/private-registries/organization-configurations#delete-a-private-registry-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/secret-name" + responses: + '204': + description: Response + '400': + "$ref": "#/components/responses/bad_request" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: private-registries + subcategory: organization-configurations "/orgs/{org}/projects": get: summary: List organization projects @@ -13037,44 +13750,7 @@ paths: content: application/json: schema: - type: object - properties: - value_type: - type: string - example: single_select - enum: - - string - - single_select - - multi_select - - true_false - description: The type of the value for the property - required: - type: boolean - description: Whether the property is required. - default_value: - oneOf: - - type: string - - type: array - items: - type: string - nullable: true - description: Default value of the property - description: - type: string - nullable: true - description: Short description of the property - allowed_values: - type: array - items: - type: string - maxLength: 75 - maxItems: 200 - nullable: true - description: |- - An ordered list of the allowed values of the property. - The property can have up to 200 allowed values. - required: - - value_type + "$ref": "#/components/schemas/custom-property-set-payload" examples: default: value: @@ -13709,6 +14385,7 @@ paths: - branch - tag - push + - repository default: branch enforcement: "$ref": "#/components/schemas/repository-rule-enforcement" @@ -13925,6 +14602,7 @@ paths: - branch - tag - push + - repository enforcement: "$ref": "#/components/schemas/repository-rule-enforcement" bypass_actors: @@ -14142,11 +14820,8 @@ paths: get: summary: List security manager teams description: |- - Lists teams that are security managers for an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." - - The authenticated user must be an administrator or security manager for the organization to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the "[Organization Roles](https://docs.github.com/rest/orgs/organization-roles)" endpoints instead. tags: - orgs operationId: orgs/list-security-manager-teams @@ -14173,15 +14848,15 @@ paths: previews: [] category: orgs subcategory: security-managers + deprecationDate: '2024-12-01' + removalDate: '2026-01-01' + deprecated: true "/orgs/{org}/security-managers/teams/{team_slug}": put: summary: Add a security manager team description: |- - Adds a team as a security manager for an organization. For more information, see "[Managing security for an organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) for an organization." - - The authenticated user must be an administrator for the organization to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the "[Organization Roles](https://docs.github.com/rest/orgs/organization-roles)" endpoints instead. tags: - orgs operationId: orgs/add-security-manager-team @@ -14200,14 +14875,14 @@ paths: previews: [] category: orgs subcategory: security-managers + deprecationDate: '2024-12-01' + removalDate: '2026-01-01' + deprecated: true delete: summary: Remove a security manager team description: |- - Removes the security manager role from a team for an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) team from an organization." - - The authenticated user must be an administrator for the organization to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the "[Organization Roles](https://docs.github.com/rest/orgs/organization-roles)" endpoints instead. tags: - orgs operationId: orgs/remove-security-manager-team @@ -14226,6 +14901,9 @@ paths: previews: [] category: orgs subcategory: security-managers + deprecationDate: '2024-12-01' + removalDate: '2026-01-01' + deprecated: true "/orgs/{org}/settings/billing/actions": get: summary: Get GitHub Actions billing for an organization @@ -18965,7 +19643,7 @@ paths: OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - This API will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`. + This endpoint will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`. tags: - actions operationId: actions/list-workflow-runs-for-repo @@ -20393,6 +21071,8 @@ paths: Anyone with read access to the repository can use this endpoint OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + + This endpoint will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`. tags: - actions operationId: actions/list-workflow-runs @@ -20775,6 +21455,8 @@ paths: Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information. repository_id: type: integer + bundle_url: + type: string examples: default: "$ref": "#/components/examples/list-attestations" @@ -24123,6 +24805,153 @@ paths: githubCloudOnly: false category: code-scanning subcategory: code-scanning + "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/autofix": + get: + summary: Get the status of an autofix for a code scanning alert + description: |- + Gets the status and description of an autofix for a code scanning alert. + + OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + tags: + - code-scanning + operationId: code-scanning/get-autofix + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/alert-number" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/code-scanning-autofix" + examples: + default: + "$ref": "#/components/examples/code-scanning-autofix" + '400': + "$ref": "#/components/responses/code_scanning_bad_request" + '403': + "$ref": "#/components/responses/code_scanning_forbidden_read" + '404': + "$ref": "#/components/responses/not_found" + '503': + "$ref": "#/components/responses/service_unavailable" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: code-scanning + subcategory: code-scanning + post: + summary: Create an autofix for a code scanning alert + description: |- + Creates an autofix for a code scanning alert. + + If a new autofix is to be created as a result of this request or is currently being generated, then this endpoint will return a 202 Accepted response. + + If an autofix already exists for a given alert, then this endpoint will return a 200 OK response. + + OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + tags: + - code-scanning + operationId: code-scanning/create-autofix + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/code-scanning/code-scanning#create-an-autofix-for-a-code-scanning-alert + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/alert-number" + responses: + '200': + description: OK + content: + application/json: + schema: + "$ref": "#/components/schemas/code-scanning-autofix" + examples: + default: + "$ref": "#/components/examples/code-scanning-autofix" + '202': + description: Accepted + content: + application/json: + schema: + "$ref": "#/components/schemas/code-scanning-autofix" + examples: + default: + "$ref": "#/components/examples/code-scanning-autofix-pending" + '400': + "$ref": "#/components/responses/code_scanning_bad_request" + '403': + "$ref": "#/components/responses/code_scanning_autofix_create_forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + description: Unprocessable Entity + '503': + "$ref": "#/components/responses/service_unavailable" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: code-scanning + subcategory: code-scanning + "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/autofix/commits": + post: + summary: Commit an autofix for a code scanning alert + description: |- + Commits an autofix for a code scanning alert. + + If an autofix is commited as a result of this request, then this endpoint will return a 201 Created response. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + tags: + - code-scanning + operationId: code-scanning/commit-autofix + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/code-scanning/code-scanning#commit-an-autofix-for-a-code-scanning-alert + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/alert-number" + requestBody: + required: false + content: + application/json: + schema: + "$ref": "#/components/schemas/code-scanning-autofix-commits" + examples: + default: + "$ref": "#/components/examples/code-scanning-autofix-commits" + responses: + '201': + description: Created + content: + application/json: + schema: + "$ref": "#/components/schemas/code-scanning-autofix-commits-response" + examples: + default: + "$ref": "#/components/examples/code-scanning-autofix-commits-response" + '400': + "$ref": "#/components/responses/code_scanning_bad_request" + '403': + "$ref": "#/components/responses/code_scanning_forbidden_write" + '404': + "$ref": "#/components/responses/not_found" + '422': + description: Unprocessable Entity + '503': + "$ref": "#/components/responses/service_unavailable" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: code-scanning + subcategory: code-scanning "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances": get: summary: List instances of a code scanning alert @@ -26334,6 +27163,7 @@ paths: | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | | `signature` | `string` | The signature that was extracted from the commit. | | `payload` | `string` | The value that was signed. | + | `verified_at` | `string` | The date the signature was verified by GitHub. | These are the possible values for `reason` in the `verification` object: @@ -26662,6 +27492,7 @@ paths: | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | | `signature` | `string` | The signature that was extracted from the commit. | | `payload` | `string` | The value that was signed. | + | `verified_at` | `string` | The date the signature was verified by GitHub. | These are the possible values for `reason` in the `verification` object: @@ -27002,6 +27833,7 @@ paths: | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | | `signature` | `string` | The signature that was extracted from the commit. | | `payload` | `string` | The value that was signed. | + | `verified_at` | `string` | The date the signature was verified by GitHub. | These are the possible values for `reason` in the `verification` object: @@ -29859,6 +30691,7 @@ paths: | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. | | `signature` | `string` | The signature that was extracted from the commit. | | `payload` | `string` | The value that was signed. | + | `verified_at` | `string` | The date the signature was verified by GitHub. | These are the possible values for `reason` in the `verification` object: @@ -30033,6 +30866,7 @@ paths: | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. | | `signature` | `string` | The signature that was extracted from the commit. | | `payload` | `string` | The value that was signed. | + | `verified_at` | `string` | The date the signature was verified by GitHub. | These are the possible values for `reason` in the `verification` object: @@ -30322,6 +31156,7 @@ paths: | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | | `signature` | `string` | The signature that was extracted from the commit. | | `payload` | `string` | The value that was signed. | + | `verified_at` | `string` | The date the signature was verified by GitHub. | These are the possible values for `reason` in the `verification` object: @@ -30448,6 +31283,7 @@ paths: | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | | `signature` | `string` | The signature that was extracted from the commit. | | `payload` | `string` | The value that was signed. | + | `verified_at` | `string` | The date the signature was verified by GitHub. | These are the possible values for `reason` in the `verification` object: @@ -30908,7 +31744,10 @@ paths: subcategory: webhooks delete: summary: Delete a repository webhook - description: '' + description: |- + Delete a webhook for an organization. + + The authenticated user must be a repository owner, or have admin access in the repository, to delete the webhook. tags: - repos operationId: repos/delete-webhook @@ -33545,6 +34384,255 @@ paths: enabledForGitHubApps: true category: reactions subcategory: reactions + "/repos/{owner}/{repo}/issues/{issue_number}/sub_issue": + delete: + summary: Remove sub-issue + description: |- + You can use the REST API to remove a sub-issue from an issue. + Removing content too quickly using this endpoint may result in secondary rate limiting. + For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass a specific media type. + - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - issues + operationId: issues/remove-sub-issue + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/sub-issues#remove-sub-issue + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/issue-number" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + sub_issue_id: + type: integer + description: The sub-issue to remove + required: + - sub_issue_id + examples: + default: + value: + sub_issue_id: 6 + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/issue" + examples: + default: + "$ref": "#/components/examples/issue" + headers: + Location: + example: https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue + schema: + type: string + '400': + "$ref": "#/components/responses/bad_request" + '404': + "$ref": "#/components/responses/not_found" + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: sub-issues + "/repos/{owner}/{repo}/issues/{issue_number}/sub_issues": + get: + summary: List sub-issues + description: |- + You can use the REST API to list the sub-issues on an issue. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - issues + operationId: issues/list-sub-issues + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/sub-issues#list-sub-issues + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/issue-number" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/issue" + examples: + default: + "$ref": "#/components/examples/issue-items" + headers: + Link: + "$ref": "#/components/headers/link" + '404': + "$ref": "#/components/responses/not_found" + '410': + "$ref": "#/components/responses/gone" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: sub-issues + post: + summary: Add sub-issue + description: |- + You can use the REST API to add sub-issues to issues. + + Creating content too quickly using this endpoint may result in secondary rate limiting. + For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - issues + operationId: issues/add-sub-issue + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/sub-issues#add-sub-issue + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/issue-number" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + sub_issue_id: + type: integer + description: The sub-issue to add + replace_parent: + type: boolean + description: Option that, when true, instructs the operation to + replace the sub-issues current parent issue + required: + - sub_issue_id + examples: + default: + value: + sub_issue_id: 1 + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/issue" + examples: + default: + "$ref": "#/components/examples/issue" + headers: + Location: + example: https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1 + schema: + type: string + '403': + "$ref": "#/components/responses/forbidden" + '410': + "$ref": "#/components/responses/gone" + '422': + "$ref": "#/components/responses/validation_failed" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: sub-issues + "/repos/{owner}/{repo}/issues/{issue_number}/sub_issues/priority": + patch: + summary: Reprioritize sub-issue + description: You can use the REST API to reprioritize a sub-issue to a different + position in the parent list. + tags: + - issues + operationId: issues/reprioritize-sub-issue + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/sub-issues#reprioritize-sub-issue + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/issue-number" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + sub_issue_id: + type: integer + description: The id of the sub-issue to reprioritize + after_id: + type: integer + description: The id of the sub-issue to be prioritized after (either + positional argument after OR before should be specified). + before_id: + type: integer + description: The id of the sub-issue to be prioritized before (either + positional argument after OR before should be specified). + required: + - sub_issue_id + examples: + default: + value: + sub_issue_id: 6 + after_id: 5 + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/issue" + examples: + default: + "$ref": "#/components/examples/issue" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed_simple" + '503': + "$ref": "#/components/responses/service_unavailable" + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: sub-issues "/repos/{owner}/{repo}/issues/{issue_number}/timeline": get: summary: List timeline events for an issue @@ -37609,7 +38697,7 @@ paths: - 'true' - 'false' - legacy - default: true + default: 'true' required: - tag_name examples: @@ -37654,10 +38742,12 @@ paths: "/repos/{owner}/{repo}/releases/assets/{asset_id}": get: summary: Get a release asset - description: To download the asset's binary content, set the `Accept` header - of the request to [`application/octet-stream`](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). - The API will either redirect the client to the location, or stream it directly - if possible. API clients should handle both a `200` or `302` response. + description: "To download the asset's binary content:\n\n- If within a browser, + fetch the location specified in the `browser_download_url` key provided in + the response.\n- Alternatively, set the `Accept` header of the request to + \n [`application/octet-stream`](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + \n The API will either redirect the client to the location, or stream it + directly if possible.\n API clients should handle both a `200` or `302` response." tags: - repos operationId: repos/get-release-asset @@ -38988,6 +40078,42 @@ paths: githubCloudOnly: false category: secret-scanning subcategory: secret-scanning + "/repos/{owner}/{repo}/secret-scanning/scan-history": + get: + summary: Get secret scanning scan history for a repository + description: |- + Lists the latest incremental and backfill scans by type for a repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + tags: + - secret-scanning + operationId: secret-scanning/get-scan-history + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/secret-scanning/secret-scanning#get-secret-scanning-scan-history-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + responses: + '404': + description: Repository does not have GitHub Advanced Security or secret + scanning enabled + '503': + "$ref": "#/components/responses/service_unavailable" + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/secret-scanning-scan-history" + examples: + default: + "$ref": "#/components/examples/secret-scanning-scan-history" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: secret-scanning + subcategory: secret-scanning "/repos/{owner}/{repo}/security-advisories": get: summary: List repository security advisories @@ -47430,6 +48556,8 @@ paths: "$ref": "#/components/schemas/sigstore-bundle-0" repository_id: type: integer + bundle_url: + type: string examples: default: value: @@ -50170,6 +51298,7 @@ x-webhooks: category: webhooks subcategory: custom_property supported-webhook-types: + - business - organization - app custom-property-deleted: @@ -50235,6 +51364,7 @@ x-webhooks: category: webhooks subcategory: custom_property supported-webhook-types: + - business - organization - app custom-property-updated: @@ -50300,6 +51430,7 @@ x-webhooks: category: webhooks subcategory: custom_property supported-webhook-types: + - business - organization - app custom-property-values-updated: @@ -63333,6 +64464,73 @@ x-webhooks: - repository - organization - app + secret-scanning-scan-completed: + post: + summary: |- + This event occurs when secret scanning completes certain scans on a repository. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." + + Scans can originate from multiple events such as updates to a custom pattern, a push to a repository, or updates + to patterns from partners. For more information on custom patterns, see "[About custom patterns](https://docs.github.com/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns)." + + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + description: A secret scanning scan was completed. + operationId: secret-scanning-scan/completed + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_scan + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-secret-scanning-scan-completed" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: secret_scanning_scan + supported-webhook-types: + - repository + - organization + - app security-advisory-published: post: summary: |- @@ -68187,668 +69385,502 @@ components: - html_url - key - name - nullable-organization-simple: - title: Organization Simple - description: A GitHub organization. + code-security-configuration: type: object + description: A code security configuration properties: - login: - type: string - example: github id: type: integer - example: 1 - node_id: - type: string - example: MDEyOk9yZ2FuaXphdGlvbjE= - url: + description: The ID of the code security configuration + name: type: string - format: uri - example: https://api.github.com/orgs/github - repos_url: + description: The name of the code security configuration. Must be unique + within the organization. + target_type: type: string - format: uri - example: https://api.github.com/orgs/github/repos - events_url: + description: The type of the code security configuration. + enum: + - global + - organization + - enterprise + description: type: string - format: uri - example: https://api.github.com/orgs/github/events - hooks_url: + description: A description of the code security configuration + advanced_security: type: string - example: https://api.github.com/orgs/github/hooks - issues_url: + description: The enablement status of GitHub Advanced Security + enum: + - enabled + - disabled + dependency_graph: type: string - example: https://api.github.com/orgs/github/issues - members_url: + description: The enablement status of Dependency Graph + enum: + - enabled + - disabled + - not_set + dependency_graph_autosubmit_action: type: string - example: https://api.github.com/orgs/github/members{/member} - public_members_url: + description: The enablement status of Automatic dependency submission + enum: + - enabled + - disabled + - not_set + dependency_graph_autosubmit_action_options: + type: object + description: Feature options for Automatic dependency submission + properties: + labeled_runners: + type: boolean + description: Whether to use runners labeled with 'dependency-submission' + or standard GitHub runners. + dependabot_alerts: type: string - example: https://api.github.com/orgs/github/public_members{/member} - avatar_url: + description: The enablement status of Dependabot alerts + enum: + - enabled + - disabled + - not_set + dependabot_security_updates: type: string - example: https://github.com/images/error/octocat_happy.gif - description: + description: The enablement status of Dependabot security updates + enum: + - enabled + - disabled + - not_set + code_scanning_default_setup: type: string - example: A great organization + description: The enablement status of code scanning default setup + enum: + - enabled + - disabled + - not_set + code_scanning_default_setup_options: + type: object + description: Feature options for code scanning default setup nullable: true - required: - - login - - url - - id - - node_id - - repos_url - - events_url - - hooks_url - - issues_url - - members_url - - public_members_url - - avatar_url - - description - nullable: true - nullable-team-simple: - title: Team Simple - description: Groups of organization members that gives permissions on specified - repositories. - type: object - properties: - id: - description: Unique identifier of the team - type: integer - example: 1 - node_id: - type: string - example: MDQ6VGVhbTE= - url: - description: URL for the team + properties: + runner_type: + nullable: true + type: string + enum: + - standard + - labeled + - not_set + description: Whether to use labeled runners or standard GitHub runners. + runner_label: + nullable: true + type: string + description: The label of the runner to use for code scanning when runner_type + is 'labeled'. + secret_scanning: type: string - format: uri - example: https://api.github.com/organizations/1/team/1 - members_url: + description: The enablement status of secret scanning + enum: + - enabled + - disabled + - not_set + secret_scanning_push_protection: type: string - example: https://api.github.com/organizations/1/team/1/members{/member} - name: - description: Name of the team + description: The enablement status of secret scanning push protection + enum: + - enabled + - disabled + - not_set + secret_scanning_delegated_bypass: type: string - example: Justice League - description: - description: Description of the team + description: The enablement status of secret scanning delegated bypass + enum: + - enabled + - disabled + - not_set + secret_scanning_delegated_bypass_options: + type: object + description: Feature options for secret scanning delegated bypass + properties: + reviewers: + type: array + description: The bypass reviewers for secret scanning delegated bypass + items: + type: object + required: + - reviewer_id + - reviewer_type + properties: + reviewer_id: + type: integer + description: The ID of the team or role selected as a bypass reviewer + reviewer_type: + type: string + description: The type of the bypass reviewer + enum: + - TEAM + - ROLE + secret_scanning_validity_checks: type: string - nullable: true - example: A great team. - permission: - description: Permission that the team will have for its repositories + description: The enablement status of secret scanning validity checks + enum: + - enabled + - disabled + - not_set + secret_scanning_non_provider_patterns: type: string - example: admin - privacy: - description: The level of privacy this team should have + description: The enablement status of secret scanning non-provider patterns + enum: + - enabled + - disabled + - not_set + private_vulnerability_reporting: type: string - example: closed - notification_setting: - description: The notification setting the team has set + description: The enablement status of private vulnerability reporting + enum: + - enabled + - disabled + - not_set + enforcement: type: string - example: notifications_enabled - html_url: + description: The enforcement status for a security configuration + enum: + - enforced + - unenforced + url: type: string format: uri - example: https://github.com/orgs/rails/teams/core - repositories_url: + description: The URL of the configuration + html_url: type: string format: uri - example: https://api.github.com/organizations/1/team/1/repos - slug: + description: The URL of the configuration + created_at: type: string - example: justice-league - ldap_dn: - description: Distinguished Name (DN) that team maps to within LDAP environment - example: uid=example,ou=users,dc=github,dc=com + format: date-time + updated_at: type: string - required: - - id - - node_id - - url - - members_url - - name - - description - - permission - - html_url - - repositories_url - - slug + format: date-time + code-scanning-default-setup-options: + type: object + description: Feature options for code scanning default setup nullable: true - team: - title: Team - description: Groups of organization members that gives permissions on specified - repositories. + properties: + runner_type: + type: string + enum: + - standard + - labeled + - not_set + description: Whether to use labeled runners or standard GitHub runners. + runner_label: + nullable: true + type: string + description: The label of the runner to use for code scanning default setup + when runner_type is 'labeled'. + code-security-default-configurations: + type: array + description: A list of default code security configurations + items: + type: object + properties: + default_for_new_repos: + enum: + - public + - private_and_internal + - all + description: The visibility of newly created repositories for which the + code security configuration will be applied to by default + configuration: + "$ref": "#/components/schemas/code-security-configuration" + simple-repository: + title: Simple Repository + description: A GitHub repository. type: object properties: id: type: integer + format: int64 + example: 1296269 + description: A unique identifier of the repository. node_id: type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + description: The GraphQL identifier of the repository. name: type: string - slug: + example: Hello-World + description: The name of the repository. + full_name: type: string + example: octocat/Hello-World + description: The full, globally unique, name of the repository. + owner: + "$ref": "#/components/schemas/simple-user" + private: + type: boolean + description: Whether the repository is private. + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: The URL to view the repository on GitHub.com. description: type: string + example: This your first repo! nullable: true - privacy: + description: The repository description. + fork: + type: boolean + description: Whether the repository is a fork. + url: type: string - notification_setting: + format: uri + example: https://api.github.com/repos/octocat/Hello-World + description: The URL to get more information about the repository from the + GitHub API. + archive_url: type: string - permission: + example: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + description: A template for the API URL to download the repository as an + archive. + assignees_url: type: string - permissions: - type: object - properties: - pull: - type: boolean - triage: - type: boolean - push: - type: boolean - maintain: - type: boolean - admin: - type: boolean - required: - - pull - - triage - - push - - maintain - - admin - url: + example: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + description: A template for the API URL to list the available assignees + for issues in the repository. + blobs_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + description: A template for the API URL to create or retrieve a raw Git + blob in the repository. + branches_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + description: A template for the API URL to get information about branches + in the repository. + collaborators_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + description: A template for the API URL to get information about collaborators + of the repository. + comments_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/comments{/number} + description: A template for the API URL to get information about comments + on the repository. + commits_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + description: A template for the API URL to get information about commits + on the repository. + compare_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + description: A template for the API URL to compare two commits or refs. + contents_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + description: A template for the API URL to get the contents of the repository. + contributors_url: type: string format: uri - html_url: + example: https://api.github.com/repos/octocat/Hello-World/contributors + description: A template for the API URL to list the contributors to the + repository. + deployments_url: type: string format: uri - example: https://github.com/orgs/rails/teams/core - members_url: + example: https://api.github.com/repos/octocat/Hello-World/deployments + description: The API URL to list the deployments of the repository. + downloads_url: type: string - repositories_url: + format: uri + example: https://api.github.com/repos/octocat/Hello-World/downloads + description: The API URL to list the downloads on the repository. + events_url: type: string format: uri - parent: - "$ref": "#/components/schemas/nullable-team-simple" - required: - - id - - node_id - - url - - members_url - - name - - description - - permission - - html_url - - repositories_url - - slug - - parent - enterprise-team: - title: Enterprise Team - description: Group of enterprise owners and/or members - type: object - properties: - id: - type: integer - format: int64 - name: + example: https://api.github.com/repos/octocat/Hello-World/events + description: The API URL to list the events of the repository. + forks_url: type: string - slug: + format: uri + example: https://api.github.com/repos/octocat/Hello-World/forks + description: The API URL to list the forks of the repository. + git_commits_url: type: string - url: + example: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + description: A template for the API URL to get information about Git commits + of the repository. + git_refs_url: type: string - format: uri - sync_to_organizations: + example: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + description: A template for the API URL to get information about Git refs + of the repository. + git_tags_url: type: string - example: disabled | all - group_id: - nullable: true + example: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + description: A template for the API URL to get information about Git tags + of the repository. + issue_comment_url: type: string - example: 62ab9291-fae2-468e-974b-7e45096d5021 - html_url: + example: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + description: A template for the API URL to get information about issue comments + on the repository. + issue_events_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + description: A template for the API URL to get information about issue events + on the repository. + issues_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/issues{/number} + description: A template for the API URL to get information about issues + on the repository. + keys_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + description: A template for the API URL to get information about deploy + keys on the repository. + labels_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/labels{/name} + description: A template for the API URL to get information about labels + of the repository. + languages_url: type: string format: uri - example: https://github.com/enterprises/dc/teams/justice-league - members_url: + example: https://api.github.com/repos/octocat/Hello-World/languages + description: The API URL to get information about the languages of the repository. + merges_url: type: string - created_at: + format: uri + example: https://api.github.com/repos/octocat/Hello-World/merges + description: The API URL to merge branches in the repository. + milestones_url: type: string - format: date-time - updated_at: + example: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + description: A template for the API URL to get information about milestones + of the repository. + notifications_url: type: string - format: date-time - required: - - id - - url - - members_url - - sync_to_organizations - - name - - html_url - - slug - - created_at - - updated_at - copilot-seat-details: - title: Copilot Business Seat Detail - description: Information about a Copilot Business seat assignment for a user, - team, or organization. - type: object - properties: - assignee: - "$ref": "#/components/schemas/simple-user" - organization: - "$ref": "#/components/schemas/nullable-organization-simple" - assigning_team: - description: The team through which the assignee is granted access to GitHub - Copilot, if applicable. - oneOf: - - "$ref": "#/components/schemas/team" - - "$ref": "#/components/schemas/enterprise-team" - nullable: true - pending_cancellation_date: + example: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + description: A template for the API URL to get information about notifications + on the repository. + pulls_url: type: string - format: date - nullable: true - description: The pending cancellation date for the seat, in `YYYY-MM-DD` - format. This will be null unless the assignee's Copilot access has been - canceled during the current billing cycle. If the seat has been cancelled, - this corresponds to the start of the organization's next billing cycle. - last_activity_at: + example: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + description: A template for the API URL to get information about pull requests + on the repository. + releases_url: type: string - format: date-time - nullable: true - description: Timestamp of user's last GitHub Copilot activity, in ISO 8601 - format. - last_activity_editor: + example: https://api.github.com/repos/octocat/Hello-World/releases{/id} + description: A template for the API URL to get information about releases + on the repository. + stargazers_url: type: string - nullable: true - description: Last editor that was used by the user for a GitHub Copilot - completion. - created_at: + format: uri + example: https://api.github.com/repos/octocat/Hello-World/stargazers + description: The API URL to list the stargazers on the repository. + statuses_url: type: string - format: date-time - description: Timestamp of when the assignee was last granted access to GitHub - Copilot, in ISO 8601 format. - updated_at: + example: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + description: A template for the API URL to get information about statuses + of a commit. + subscribers_url: type: string - format: date-time - description: Timestamp of when the assignee's GitHub Copilot access was - last updated, in ISO 8601 format. - plan_type: + format: uri + example: https://api.github.com/repos/octocat/Hello-World/subscribers + description: The API URL to list the subscribers on the repository. + subscription_url: type: string - description: The Copilot plan of the organization, or the parent enterprise, - when applicable. - enum: - - business - - enterprise - - unknown - required: - - assignee - - created_at - additionalProperties: false - copilot-ide-code-completions: - type: object - description: Usage metrics for Copilot editor code completions in the IDE. - nullable: true - additionalProperties: true - properties: - total_engaged_users: - type: integer - description: Number of users who accepted at least one Copilot code suggestion, - across all active editors. Includes both full and partial acceptances. - languages: - type: array - description: Code completion metrics for active languages. - items: - type: object - description: Usage metrics for a given language for the given editor for - Copilot code completions. - properties: - name: - type: string - description: Name of the language used for Copilot code completion - suggestions. - total_engaged_users: - type: integer - description: Number of users who accepted at least one Copilot code - completion suggestion for the given language. Includes both full - and partial acceptances. - editors: - type: array - items: - type: object - description: Copilot code completion metrics for active editors. - additionalProperties: true - properties: - name: - type: string - description: Name of the given editor. - total_engaged_users: - type: integer - description: Number of users who accepted at least one Copilot code - completion suggestion for the given editor. Includes both full and - partial acceptances. - models: - type: array - description: List of model metrics for custom models and the default - model. - items: - type: object - properties: - name: - type: string - description: Name of the language used for Copilot code completion - suggestions, for the given editor. - is_custom_model: - type: boolean - description: Indicates whether a model is custom or default. - custom_model_training_date: - type: string - nullable: true - description: The training date for the custom model. - total_engaged_users: - type: integer - description: Number of users who accepted at least one Copilot - code completion suggestion for the given editor, for the given - language and model. Includes both full and partial acceptances. - languages: - type: array - description: Code completion metrics for active languages, for - the given editor. - items: - type: object - description: Usage metrics for a given language for the given - editor for Copilot code completions. - properties: - name: - type: string - description: Name of the language used for Copilot code - completion suggestions, for the given editor. - total_engaged_users: - type: integer - description: Number of users who accepted at least one - Copilot code completion suggestion for the given editor, - for the given language. Includes both full and partial - acceptances. - total_code_suggestions: - type: integer - description: The number of Copilot code suggestions generated - for the given editor, for the given language. - total_code_acceptances: - type: integer - description: The number of Copilot code suggestions accepted - for the given editor, for the given language. Includes - both full and partial acceptances. - total_code_lines_suggested: - type: integer - description: The number of lines of code suggested by - Copilot code completions for the given editor, for the - given language. - total_code_lines_accepted: - type: integer - description: The number of lines of code accepted from - Copilot code suggestions for the given editor, for the - given language. - copilot-ide-chat: - type: object - description: Usage metrics for Copilot Chat in the IDE. - nullable: true - additionalProperties: true - properties: - total_engaged_users: - type: integer - description: Total number of users who prompted Copilot Chat in the IDE. - editors: - type: array - items: - type: object - description: Copilot Chat metrics, for active editors. - properties: - name: - type: string - description: Name of the given editor. - total_engaged_users: - type: integer - description: The number of users who prompted Copilot Chat in the - specified editor. - models: - type: array - description: List of model metrics for custom models and the default - model. - items: - type: object - properties: - name: - type: string - description: Name of the language used for Copilot code completion - suggestions, for the given editor. - is_custom_model: - type: boolean - description: Indicates whether a model is custom or default. - custom_model_training_date: - type: string - nullable: true - description: The training date for the custom model. - total_engaged_users: - type: integer - description: The number of users who prompted Copilot Chat in - the given editor and model. - total_chats: - type: integer - description: The total number of chats initiated by users in - the given editor and model. - total_chat_insertion_events: - type: integer - description: The number of times users accepted a code suggestion - from Copilot Chat using the 'Insert Code' UI element, for - the given editor. - total_chat_copy_events: - type: integer - description: The number of times users copied a code suggestion - from Copilot Chat using the keyboard, or the 'Copy' UI element, - for the given editor. - copilot-dotcom-chat: - type: object - description: Usage metrics for Copilot Chat in github.com - nullable: true - additionalProperties: true - properties: - total_engaged_users: - type: integer - description: Total number of users who prompted Copilot Chat on github.com - at least once. - models: - type: array - description: List of model metrics for a custom models and the default model. - items: - type: object - properties: - name: - type: string - description: Name of the language used for Copilot code completion - suggestions, for the given editor. - is_custom_model: - type: boolean - description: Indicates whether a model is custom or default. - custom_model_training_date: - type: string - description: The training date for the custom model (if applicable). - nullable: true - total_engaged_users: - type: integer - description: Total number of users who prompted Copilot Chat on github.com - at least once for each model. - total_chats: - type: integer - description: Total number of chats initiated by users on github.com. - copilot-dotcom-pull-requests: - type: object - description: Usage metrics for Copilot for pull requests. - nullable: true - additionalProperties: true - properties: - total_engaged_users: - type: integer - description: The number of users who used Copilot for Pull Requests on github.com - to generate a pull request summary at least once. - repositories: - type: array - description: Repositories in which users used Copilot for Pull Requests - to generate pull request summaries - items: - type: object - properties: - name: - type: string - description: Repository name - total_engaged_users: - type: integer - description: The number of users who generated pull request summaries - using Copilot for Pull Requests in the given repository. - models: - type: array - description: List of model metrics for custom models and the default - model. - items: - type: object - properties: - name: - type: string - description: Name of the language used for Copilot code completion - suggestions, for the given editor. - is_custom_model: - type: boolean - description: Indicates whether a model is custom or default. - custom_model_training_date: - type: string - nullable: true - description: The training date for the custom model. - total_pr_summaries_created: - type: integer - description: The number of pull request summaries generated - using Copilot for Pull Requests in the given repository. - total_engaged_users: - type: integer - description: The number of users who generated pull request - summaries using Copilot for Pull Requests in the given repository - and model. - copilot-usage-metrics-day: - title: Copilot Usage Metrics - description: Copilot usage metrics for a given day. - type: object - properties: - date: + format: uri + example: https://api.github.com/repos/octocat/Hello-World/subscription + description: The API URL to subscribe to notifications for this repository. + tags_url: type: string - format: date - description: The date for which the usage metrics are aggregated, in `YYYY-MM-DD` - format. - total_active_users: - type: integer - description: The total number of Copilot users with activity belonging to - any Copilot feature, globally, for the given day. Includes passive activity - such as receiving a code suggestion, as well as engagement activity such - as accepting a code suggestion or prompting chat. Does not include authentication - events. Is not limited to the individual features detailed on the endpoint. - total_engaged_users: - type: integer - description: The total number of Copilot users who engaged with any Copilot - feature, for the given day. Examples include but are not limited to accepting - a code suggestion, prompting Copilot chat, or triggering a PR Summary. - Does not include authentication events. Is not limited to the individual - features detailed on the endpoint. - copilot_ide_code_completions: - "$ref": "#/components/schemas/copilot-ide-code-completions" - copilot_ide_chat: - "$ref": "#/components/schemas/copilot-ide-chat" - copilot_dotcom_chat: - "$ref": "#/components/schemas/copilot-dotcom-chat" - copilot_dotcom_pull_requests: - "$ref": "#/components/schemas/copilot-dotcom-pull-requests" + format: uri + example: https://api.github.com/repos/octocat/Hello-World/tags + description: The API URL to get information about tags on the repository. + teams_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/teams + description: The API URL to list the teams on the repository. + trees_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + description: A template for the API URL to create or retrieve a raw Git + tree of the repository. + hooks_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/hooks + description: The API URL to list the hooks on the repository. required: - - date - additionalProperties: true - copilot-usage-metrics: - title: Copilot Usage Metrics - description: Summary of Copilot usage. + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + code-security-configuration-repositories: type: object + description: Repositories associated with a code security configuration and + attachment status properties: - day: + status: type: string - format: date - description: The date for which the usage metrics are reported, in `YYYY-MM-DD` - format. - total_suggestions_count: - type: integer - description: The total number of Copilot code completion suggestions shown - to users. - total_acceptances_count: - type: integer - description: The total number of Copilot code completion suggestions accepted - by users. - total_lines_suggested: - type: integer - description: The total number of lines of code completions suggested by - Copilot. - total_lines_accepted: - type: integer - description: The total number of lines of code completions accepted by users. - total_active_users: - type: integer - description: The total number of users who were shown Copilot code completion - suggestions during the day specified. - total_chat_acceptances: - type: integer - description: The total instances of users who accepted code suggested by - Copilot Chat in the IDE (panel and inline). - total_chat_turns: - type: integer - description: The total number of chat turns (prompt and response pairs) - sent between users and Copilot Chat in the IDE. - total_active_chat_users: - type: integer - description: The total number of users who interacted with Copilot Chat - in the IDE during the day specified. - breakdown: - type: array - description: Breakdown of Copilot code completions usage by language and - editor - nullable: true - items: - type: object - description: Breakdown of Copilot usage by editor for this language - additionalProperties: true - properties: - language: - type: string - description: The language in which Copilot suggestions were shown - to users in the specified editor. - editor: - type: string - description: The editor in which Copilot suggestions were shown to - users for the specified language. - suggestions_count: - type: integer - description: The number of Copilot suggestions shown to users in the - editor specified during the day specified. - acceptances_count: - type: integer - description: The number of Copilot suggestions accepted by users in - the editor specified during the day specified. - lines_suggested: - type: integer - description: The number of lines of code suggested by Copilot in the - editor specified during the day specified. - lines_accepted: - type: integer - description: The number of lines of code accepted by users in the - editor specified during the day specified. - active_users: - type: integer - description: The number of users who were shown Copilot completion - suggestions in the editor specified during the day specified. - required: - - day - - breakdown - additionalProperties: false + description: The attachment status of the code security configuration on + the repository. + enum: + - attached + - attaching + - detached + - removed + - enforced + - failed + - updating + - removed_by_enterprise + repository: + "$ref": "#/components/schemas/simple-repository" alert-number: type: integer description: The security alert number. @@ -69109,278 +70141,6 @@ components: format: date-time readOnly: true nullable: true - simple-repository: - title: Simple Repository - description: A GitHub repository. - type: object - properties: - id: - type: integer - format: int64 - example: 1296269 - description: A unique identifier of the repository. - node_id: - type: string - example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - description: The GraphQL identifier of the repository. - name: - type: string - example: Hello-World - description: The name of the repository. - full_name: - type: string - example: octocat/Hello-World - description: The full, globally unique, name of the repository. - owner: - "$ref": "#/components/schemas/simple-user" - private: - type: boolean - description: Whether the repository is private. - html_url: - type: string - format: uri - example: https://github.com/octocat/Hello-World - description: The URL to view the repository on GitHub.com. - description: - type: string - example: This your first repo! - nullable: true - description: The repository description. - fork: - type: boolean - description: Whether the repository is a fork. - url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World - description: The URL to get more information about the repository from the - GitHub API. - archive_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - description: A template for the API URL to download the repository as an - archive. - assignees_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/assignees{/user} - description: A template for the API URL to list the available assignees - for issues in the repository. - blobs_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - description: A template for the API URL to create or retrieve a raw Git - blob in the repository. - branches_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/branches{/branch} - description: A template for the API URL to get information about branches - in the repository. - collaborators_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - description: A template for the API URL to get information about collaborators - of the repository. - comments_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/comments{/number} - description: A template for the API URL to get information about comments - on the repository. - commits_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/commits{/sha} - description: A template for the API URL to get information about commits - on the repository. - compare_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - description: A template for the API URL to compare two commits or refs. - contents_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/contents/{+path} - description: A template for the API URL to get the contents of the repository. - contributors_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/contributors - description: A template for the API URL to list the contributors to the - repository. - deployments_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/deployments - description: The API URL to list the deployments of the repository. - downloads_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/downloads - description: The API URL to list the downloads on the repository. - events_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/events - description: The API URL to list the events of the repository. - forks_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/forks - description: The API URL to list the forks of the repository. - git_commits_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - description: A template for the API URL to get information about Git commits - of the repository. - git_refs_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - description: A template for the API URL to get information about Git refs - of the repository. - git_tags_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - description: A template for the API URL to get information about Git tags - of the repository. - issue_comment_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - description: A template for the API URL to get information about issue comments - on the repository. - issue_events_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} - description: A template for the API URL to get information about issue events - on the repository. - issues_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/issues{/number} - description: A template for the API URL to get information about issues - on the repository. - keys_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} - description: A template for the API URL to get information about deploy - keys on the repository. - labels_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/labels{/name} - description: A template for the API URL to get information about labels - of the repository. - languages_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/languages - description: The API URL to get information about the languages of the repository. - merges_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/merges - description: The API URL to merge branches in the repository. - milestones_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/milestones{/number} - description: A template for the API URL to get information about milestones - of the repository. - notifications_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - description: A template for the API URL to get information about notifications - on the repository. - pulls_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/pulls{/number} - description: A template for the API URL to get information about pull requests - on the repository. - releases_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/releases{/id} - description: A template for the API URL to get information about releases - on the repository. - stargazers_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/stargazers - description: The API URL to list the stargazers on the repository. - statuses_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} - description: A template for the API URL to get information about statuses - of a commit. - subscribers_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/subscribers - description: The API URL to list the subscribers on the repository. - subscription_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/subscription - description: The API URL to subscribe to notifications for this repository. - tags_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/tags - description: The API URL to get information about tags on the repository. - teams_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/teams - description: The API URL to list the teams on the repository. - trees_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - description: A template for the API URL to create or retrieve a raw Git - tree of the repository. - hooks_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/hooks - description: The API URL to list the hooks on the repository. - required: - - archive_url - - assignees_url - - blobs_url - - branches_url - - collaborators_url - - comments_url - - commits_url - - compare_url - - contents_url - - contributors_url - - deployments_url - - description - - downloads_url - - events_url - - fork - - forks_url - - full_name - - git_commits_url - - git_refs_url - - git_tags_url - - hooks_url - - html_url - - id - - node_id - - issue_comment_url - - issue_events_url - - issues_url - - keys_url - - labels_url - - languages_url - - merges_url - - milestones_url - - name - - notifications_url - - owner - - private - - pulls_url - - releases_url - - stargazers_url - - statuses_url - - subscribers_url - - subscription_url - - tags_url - - teams_url - - trees_url - - url dependabot-alert-with-repository: type: object description: A Dependabot alert. @@ -69546,6 +70306,21 @@ components: description: 'The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' nullable: true + push_protection_bypass_request_reviewer: + "$ref": "#/components/schemas/nullable-simple-user" + push_protection_bypass_request_reviewer_comment: + type: string + description: An optional comment when reviewing a push protection bypass. + nullable: true + push_protection_bypass_request_comment: + type: string + description: An optional comment when requesting a push protection bypass. + nullable: true + push_protection_bypass_request_html_url: + type: string + format: uri + description: The URL to a push protection bypass request. + nullable: true resolution_comment: type: string description: The comment that was optionally added when this alert was closed @@ -69832,6 +70607,20 @@ components: - hooray - eyes - rocket + sub-issues-summary: + title: Sub-issues Summary + type: object + properties: + total: + type: integer + completed: + type: integer + percent_completed: + type: integer + required: + - total + - completed + - percent_completed issue: title: Issue description: Issues are a great way to keep track of tasks, enhancements, and @@ -69997,6 +70786,8 @@ components: "$ref": "#/components/schemas/author-association" reactions: "$ref": "#/components/schemas/reaction-rollup" + sub_issues_summary: + "$ref": "#/components/schemas/sub-issues-summary" required: - assignee - closed_at @@ -71190,6 +71981,21 @@ components: type: string example: - example.com + actions_inbound: + type: object + properties: + full_domains: + type: array + items: + type: string + example: + - example.com + wildcard_domains: + type: array + items: + type: string + example: + - example.com artifact_attestations: type: object properties: @@ -71733,6 +72539,58 @@ components: - public_members_url - avatar_url - description + billing-usage-report: + type: object + properties: + usageItems: + type: array + items: + type: object + properties: + date: + type: string + description: Date of the usage line item. + product: + type: string + description: Product name. + sku: + type: string + description: SKU name. + quantity: + type: integer + description: Quantity of the usage line item. + unitType: + type: string + description: Unit type of the usage line item. + pricePerUnit: + type: number + description: Price per unit of the usage line item. + grossAmount: + type: number + description: Gross amount of the usage line item. + discountAmount: + type: number + description: Discount amount of the usage line item. + netAmount: + type: number + description: Net amount of the usage line item. + organizationName: + type: string + description: Name of the organization. + repositoryName: + type: string + description: Name of the repository. + required: + - date + - product + - sku + - quantity + - unitType + - pricePerUnit + - grossAmount + - discountAmount + - netAmount + - organizationName organization-full: title: Organization Full description: Organization Full @@ -72674,195 +73532,6 @@ components: - tool - most_recent_instance - repository - code-security-configuration: - type: object - description: A code security configuration - properties: - id: - type: integer - description: The ID of the code security configuration - name: - type: string - description: The name of the code security configuration. Must be unique - within the organization. - target_type: - type: string - description: The type of the code security configuration. - enum: - - global - - organization - - enterprise - description: - type: string - description: A description of the code security configuration - advanced_security: - type: string - description: The enablement status of GitHub Advanced Security - enum: - - enabled - - disabled - dependency_graph: - type: string - description: The enablement status of Dependency Graph - enum: - - enabled - - disabled - - not_set - dependency_graph_autosubmit_action: - type: string - description: The enablement status of Automatic dependency submission - enum: - - enabled - - disabled - - not_set - dependency_graph_autosubmit_action_options: - type: object - description: Feature options for Automatic dependency submission - properties: - labeled_runners: - type: boolean - description: Whether to use runners labeled with 'dependency-submission' - or standard GitHub runners. - dependabot_alerts: - type: string - description: The enablement status of Dependabot alerts - enum: - - enabled - - disabled - - not_set - dependabot_security_updates: - type: string - description: The enablement status of Dependabot security updates - enum: - - enabled - - disabled - - not_set - code_scanning_default_setup: - type: string - description: The enablement status of code scanning default setup - enum: - - enabled - - disabled - - not_set - secret_scanning: - type: string - description: The enablement status of secret scanning - enum: - - enabled - - disabled - - not_set - secret_scanning_push_protection: - type: string - description: The enablement status of secret scanning push protection - enum: - - enabled - - disabled - - not_set - secret_scanning_delegated_bypass: - type: string - description: The enablement status of secret scanning delegated bypass - enum: - - enabled - - disabled - - not_set - secret_scanning_delegated_bypass_options: - type: object - description: Feature options for secret scanning delegated bypass - properties: - reviewers: - type: array - description: The bypass reviewers for secret scanning delegated bypass - items: - type: object - required: - - reviewer_id - - reviewer_type - properties: - reviewer_id: - type: integer - description: The ID of the team or role selected as a bypass reviewer - reviewer_type: - type: string - description: The type of the bypass reviewer - enum: - - TEAM - - ROLE - secret_scanning_validity_checks: - type: string - description: The enablement status of secret scanning validity checks - enum: - - enabled - - disabled - - not_set - secret_scanning_non_provider_patterns: - type: string - description: The enablement status of secret scanning non-provider patterns - enum: - - enabled - - disabled - - not_set - private_vulnerability_reporting: - type: string - description: The enablement status of private vulnerability reporting - enum: - - enabled - - disabled - - not_set - enforcement: - type: string - description: The enforcement status for a security configuration - enum: - - enforced - - unenforced - url: - type: string - format: uri - description: The URL of the configuration - html_url: - type: string - format: uri - description: The URL of the configuration - created_at: - type: string - format: date-time - updated_at: - type: string - format: date-time - code-security-default-configurations: - type: array - description: A list of default code security configurations - items: - type: object - properties: - default_for_new_repos: - enum: - - public - - private_and_internal - - all - description: The visibility of newly created repositories for which the - code security configuration will be applied to by default - configuration: - "$ref": "#/components/schemas/code-security-configuration" - code-security-configuration-repositories: - type: object - description: Repositories associated with a code security configuration and - attachment status - properties: - status: - type: string - description: The attachment status of the code security configuration on - the repository. - enum: - - attached - - attaching - - detached - - removed - - enforced - - failed - - updating - - removed_by_enterprise - repository: - "$ref": "#/components/schemas/simple-repository" nullable-codespace-machine: type: object title: Codespace machine @@ -73291,6 +73960,671 @@ components: - public_code_suggestions - seat_management_setting additionalProperties: true + nullable-organization-simple: + title: Organization Simple + description: A GitHub organization. + type: object + properties: + login: + type: string + example: github + id: + type: integer + example: 1 + node_id: + type: string + example: MDEyOk9yZ2FuaXphdGlvbjE= + url: + type: string + format: uri + example: https://api.github.com/orgs/github + repos_url: + type: string + format: uri + example: https://api.github.com/orgs/github/repos + events_url: + type: string + format: uri + example: https://api.github.com/orgs/github/events + hooks_url: + type: string + example: https://api.github.com/orgs/github/hooks + issues_url: + type: string + example: https://api.github.com/orgs/github/issues + members_url: + type: string + example: https://api.github.com/orgs/github/members{/member} + public_members_url: + type: string + example: https://api.github.com/orgs/github/public_members{/member} + avatar_url: + type: string + example: https://github.com/images/error/octocat_happy.gif + description: + type: string + example: A great organization + nullable: true + required: + - login + - url + - id + - node_id + - repos_url + - events_url + - hooks_url + - issues_url + - members_url + - public_members_url + - avatar_url + - description + nullable: true + nullable-team-simple: + title: Team Simple + description: Groups of organization members that gives permissions on specified + repositories. + type: object + properties: + id: + description: Unique identifier of the team + type: integer + example: 1 + node_id: + type: string + example: MDQ6VGVhbTE= + url: + description: URL for the team + type: string + format: uri + example: https://api.github.com/organizations/1/team/1 + members_url: + type: string + example: https://api.github.com/organizations/1/team/1/members{/member} + name: + description: Name of the team + type: string + example: Justice League + description: + description: Description of the team + type: string + nullable: true + example: A great team. + permission: + description: Permission that the team will have for its repositories + type: string + example: admin + privacy: + description: The level of privacy this team should have + type: string + example: closed + notification_setting: + description: The notification setting the team has set + type: string + example: notifications_enabled + html_url: + type: string + format: uri + example: https://github.com/orgs/rails/teams/core + repositories_url: + type: string + format: uri + example: https://api.github.com/organizations/1/team/1/repos + slug: + type: string + example: justice-league + ldap_dn: + description: Distinguished Name (DN) that team maps to within LDAP environment + example: uid=example,ou=users,dc=github,dc=com + type: string + required: + - id + - node_id + - url + - members_url + - name + - description + - permission + - html_url + - repositories_url + - slug + nullable: true + team: + title: Team + description: Groups of organization members that gives permissions on specified + repositories. + type: object + properties: + id: + type: integer + node_id: + type: string + name: + type: string + slug: + type: string + description: + type: string + nullable: true + privacy: + type: string + notification_setting: + type: string + permission: + type: string + permissions: + type: object + properties: + pull: + type: boolean + triage: + type: boolean + push: + type: boolean + maintain: + type: boolean + admin: + type: boolean + required: + - pull + - triage + - push + - maintain + - admin + url: + type: string + format: uri + html_url: + type: string + format: uri + example: https://github.com/orgs/rails/teams/core + members_url: + type: string + repositories_url: + type: string + format: uri + parent: + "$ref": "#/components/schemas/nullable-team-simple" + required: + - id + - node_id + - url + - members_url + - name + - description + - permission + - html_url + - repositories_url + - slug + - parent + enterprise-team: + title: Enterprise Team + description: Group of enterprise owners and/or members + type: object + properties: + id: + type: integer + format: int64 + name: + type: string + slug: + type: string + url: + type: string + format: uri + sync_to_organizations: + type: string + example: disabled | all + group_id: + nullable: true + type: string + example: 62ab9291-fae2-468e-974b-7e45096d5021 + html_url: + type: string + format: uri + example: https://github.com/enterprises/dc/teams/justice-league + members_url: + type: string + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + required: + - id + - url + - members_url + - sync_to_organizations + - name + - html_url + - slug + - created_at + - updated_at + copilot-seat-details: + title: Copilot Business Seat Detail + description: Information about a Copilot Business seat assignment for a user, + team, or organization. + type: object + properties: + assignee: + "$ref": "#/components/schemas/simple-user" + organization: + "$ref": "#/components/schemas/nullable-organization-simple" + assigning_team: + description: The team through which the assignee is granted access to GitHub + Copilot, if applicable. + oneOf: + - "$ref": "#/components/schemas/team" + - "$ref": "#/components/schemas/enterprise-team" + nullable: true + pending_cancellation_date: + type: string + format: date + nullable: true + description: The pending cancellation date for the seat, in `YYYY-MM-DD` + format. This will be null unless the assignee's Copilot access has been + canceled during the current billing cycle. If the seat has been cancelled, + this corresponds to the start of the organization's next billing cycle. + last_activity_at: + type: string + format: date-time + nullable: true + description: Timestamp of user's last GitHub Copilot activity, in ISO 8601 + format. + last_activity_editor: + type: string + nullable: true + description: Last editor that was used by the user for a GitHub Copilot + completion. + created_at: + type: string + format: date-time + description: Timestamp of when the assignee was last granted access to GitHub + Copilot, in ISO 8601 format. + updated_at: + type: string + format: date-time + deprecated: true + description: "**Closing down notice:** This field is no longer relevant + and is closing down. Use the `created_at` field to determine when the + assignee was last granted access to GitHub Copilot. Timestamp of when + the assignee's GitHub Copilot access was last updated, in ISO 8601 format." + plan_type: + type: string + description: The Copilot plan of the organization, or the parent enterprise, + when applicable. + enum: + - business + - enterprise + - unknown + required: + - assignee + - created_at + additionalProperties: false + copilot-ide-code-completions: + type: object + description: Usage metrics for Copilot editor code completions in the IDE. + nullable: true + additionalProperties: true + properties: + total_engaged_users: + type: integer + description: Number of users who accepted at least one Copilot code suggestion, + across all active editors. Includes both full and partial acceptances. + languages: + type: array + description: Code completion metrics for active languages. + items: + type: object + description: Usage metrics for a given language for the given editor for + Copilot code completions. + properties: + name: + type: string + description: Name of the language used for Copilot code completion + suggestions. + total_engaged_users: + type: integer + description: Number of users who accepted at least one Copilot code + completion suggestion for the given language. Includes both full + and partial acceptances. + editors: + type: array + items: + type: object + description: Copilot code completion metrics for active editors. + additionalProperties: true + properties: + name: + type: string + description: Name of the given editor. + total_engaged_users: + type: integer + description: Number of users who accepted at least one Copilot code + completion suggestion for the given editor. Includes both full and + partial acceptances. + models: + type: array + description: List of model metrics for custom models and the default + model. + items: + type: object + properties: + name: + type: string + description: Name of the model used for Copilot code completion + suggestions. If the default model is used will appear as 'default'. + is_custom_model: + type: boolean + description: Indicates whether a model is custom or default. + custom_model_training_date: + type: string + nullable: true + description: The training date for the custom model. + total_engaged_users: + type: integer + description: Number of users who accepted at least one Copilot + code completion suggestion for the given editor, for the given + language and model. Includes both full and partial acceptances. + languages: + type: array + description: Code completion metrics for active languages, for + the given editor. + items: + type: object + description: Usage metrics for a given language for the given + editor for Copilot code completions. + properties: + name: + type: string + description: Name of the language used for Copilot code + completion suggestions, for the given editor. + total_engaged_users: + type: integer + description: Number of users who accepted at least one + Copilot code completion suggestion for the given editor, + for the given language. Includes both full and partial + acceptances. + total_code_suggestions: + type: integer + description: The number of Copilot code suggestions generated + for the given editor, for the given language. + total_code_acceptances: + type: integer + description: The number of Copilot code suggestions accepted + for the given editor, for the given language. Includes + both full and partial acceptances. + total_code_lines_suggested: + type: integer + description: The number of lines of code suggested by + Copilot code completions for the given editor, for the + given language. + total_code_lines_accepted: + type: integer + description: The number of lines of code accepted from + Copilot code suggestions for the given editor, for the + given language. + copilot-ide-chat: + type: object + description: Usage metrics for Copilot Chat in the IDE. + nullable: true + additionalProperties: true + properties: + total_engaged_users: + type: integer + description: Total number of users who prompted Copilot Chat in the IDE. + editors: + type: array + items: + type: object + description: Copilot Chat metrics, for active editors. + properties: + name: + type: string + description: Name of the given editor. + total_engaged_users: + type: integer + description: The number of users who prompted Copilot Chat in the + specified editor. + models: + type: array + description: List of model metrics for custom models and the default + model. + items: + type: object + properties: + name: + type: string + description: Name of the model used for Copilot code completion + suggestions. If the default model is used will appear as 'default'. + is_custom_model: + type: boolean + description: Indicates whether a model is custom or default. + custom_model_training_date: + type: string + nullable: true + description: The training date for the custom model. + total_engaged_users: + type: integer + description: The number of users who prompted Copilot Chat in + the given editor and model. + total_chats: + type: integer + description: The total number of chats initiated by users in + the given editor and model. + total_chat_insertion_events: + type: integer + description: The number of times users accepted a code suggestion + from Copilot Chat using the 'Insert Code' UI element, for + the given editor. + total_chat_copy_events: + type: integer + description: The number of times users copied a code suggestion + from Copilot Chat using the keyboard, or the 'Copy' UI element, + for the given editor. + copilot-dotcom-chat: + type: object + description: Usage metrics for Copilot Chat in github.com + nullable: true + additionalProperties: true + properties: + total_engaged_users: + type: integer + description: Total number of users who prompted Copilot Chat on github.com + at least once. + models: + type: array + description: List of model metrics for a custom models and the default model. + items: + type: object + properties: + name: + type: string + description: Name of the model used for Copilot code completion suggestions. + If the default model is used will appear as 'default'. + is_custom_model: + type: boolean + description: Indicates whether a model is custom or default. + custom_model_training_date: + type: string + description: The training date for the custom model (if applicable). + nullable: true + total_engaged_users: + type: integer + description: Total number of users who prompted Copilot Chat on github.com + at least once for each model. + total_chats: + type: integer + description: Total number of chats initiated by users on github.com. + copilot-dotcom-pull-requests: + type: object + description: Usage metrics for Copilot for pull requests. + nullable: true + additionalProperties: true + properties: + total_engaged_users: + type: integer + description: The number of users who used Copilot for Pull Requests on github.com + to generate a pull request summary at least once. + repositories: + type: array + description: Repositories in which users used Copilot for Pull Requests + to generate pull request summaries + items: + type: object + properties: + name: + type: string + description: Repository name + total_engaged_users: + type: integer + description: The number of users who generated pull request summaries + using Copilot for Pull Requests in the given repository. + models: + type: array + description: List of model metrics for custom models and the default + model. + items: + type: object + properties: + name: + type: string + description: Name of the model used for Copilot code completion + suggestions. If the default model is used will appear as 'default'. + is_custom_model: + type: boolean + description: Indicates whether a model is custom or default. + custom_model_training_date: + type: string + nullable: true + description: The training date for the custom model. + total_pr_summaries_created: + type: integer + description: The number of pull request summaries generated + using Copilot for Pull Requests in the given repository. + total_engaged_users: + type: integer + description: The number of users who generated pull request + summaries using Copilot for Pull Requests in the given repository + and model. + copilot-usage-metrics-day: + title: Copilot Usage Metrics + description: Copilot usage metrics for a given day. + type: object + properties: + date: + type: string + format: date + description: The date for which the usage metrics are aggregated, in `YYYY-MM-DD` + format. + total_active_users: + type: integer + description: The total number of Copilot users with activity belonging to + any Copilot feature, globally, for the given day. Includes passive activity + such as receiving a code suggestion, as well as engagement activity such + as accepting a code suggestion or prompting chat. Does not include authentication + events. Is not limited to the individual features detailed on the endpoint. + total_engaged_users: + type: integer + description: The total number of Copilot users who engaged with any Copilot + feature, for the given day. Examples include but are not limited to accepting + a code suggestion, prompting Copilot chat, or triggering a PR Summary. + Does not include authentication events. Is not limited to the individual + features detailed on the endpoint. + copilot_ide_code_completions: + "$ref": "#/components/schemas/copilot-ide-code-completions" + copilot_ide_chat: + "$ref": "#/components/schemas/copilot-ide-chat" + copilot_dotcom_chat: + "$ref": "#/components/schemas/copilot-dotcom-chat" + copilot_dotcom_pull_requests: + "$ref": "#/components/schemas/copilot-dotcom-pull-requests" + required: + - date + additionalProperties: true + copilot-usage-metrics: + title: Copilot Usage Metrics + description: Summary of Copilot usage. + type: object + properties: + day: + type: string + format: date + description: The date for which the usage metrics are reported, in `YYYY-MM-DD` + format. + total_suggestions_count: + type: integer + description: The total number of Copilot code completion suggestions shown + to users. + total_acceptances_count: + type: integer + description: The total number of Copilot code completion suggestions accepted + by users. + total_lines_suggested: + type: integer + description: The total number of lines of code completions suggested by + Copilot. + total_lines_accepted: + type: integer + description: The total number of lines of code completions accepted by users. + total_active_users: + type: integer + description: The total number of users who were shown Copilot code completion + suggestions during the day specified. + total_chat_acceptances: + type: integer + description: The total instances of users who accepted code suggested by + Copilot Chat in the IDE (panel and inline). + total_chat_turns: + type: integer + description: The total number of chat turns (prompt and response pairs) + sent between users and Copilot Chat in the IDE. + total_active_chat_users: + type: integer + description: The total number of users who interacted with Copilot Chat + in the IDE during the day specified. + breakdown: + type: array + description: Breakdown of Copilot code completions usage by language and + editor + nullable: true + items: + type: object + description: Breakdown of Copilot usage by editor for this language + additionalProperties: true + properties: + language: + type: string + description: The language in which Copilot suggestions were shown + to users in the specified editor. + editor: + type: string + description: The editor in which Copilot suggestions were shown to + users for the specified language. + suggestions_count: + type: integer + description: The number of Copilot suggestions shown to users in the + editor specified during the day specified. + acceptances_count: + type: integer + description: The number of Copilot suggestions accepted by users in + the editor specified during the day specified. + lines_suggested: + type: integer + description: The number of lines of code suggested by Copilot in the + editor specified during the day specified. + lines_accepted: + type: integer + description: The number of lines of code accepted by users in the + editor specified during the day specified. + active_users: + type: integer + description: The number of users who were shown Copilot completion + suggestions in the editor specified during the day specified. + required: + - day + - breakdown + additionalProperties: false organization-dependabot-secret: title: Dependabot Secret for an Organization description: Secrets for GitHub Dependabot for an organization. @@ -74147,6 +75481,24 @@ components: it grants. type: string nullable: true + base_role: + type: string + nullable: true + description: The system role from which this role inherits permissions. + enum: + - read + - triage + - write + - maintain + - admin + source: + type: string + nullable: true + description: Source answers the question, "where did this role come from?" + enum: + - Organization + - Enterprise + - Predefined permissions: description: A list of permissions included in this role. type: array @@ -74174,6 +75526,15 @@ components: description: The Relationship a Team has with a role. type: object properties: + assignment: + type: string + description: Determines if the team has a direct, indirect, or mixed relationship + to a role + enum: + - direct + - indirect + - mixed + example: direct id: type: integer node_id: @@ -74309,6 +75670,20 @@ components: description: The Relationship a User has with a role. type: object properties: + assignment: + type: string + description: Determines if the user has a direct, indirect, or mixed relationship + to a role + enum: + - direct + - indirect + - mixed + example: direct + inherited_from: + description: Team the user has gotten the role through + type: array + items: + "$ref": "#/components/schemas/team-simple" name: nullable: true type: string @@ -74646,6 +76021,90 @@ components: - token_expired - token_expires_at - token_last_used_at + org-private-registry-configuration: + title: Organization private registry + description: Private registry configuration for an organization + type: object + properties: + name: + description: The name of the private registry configuration. + example: MAVEN_REPOSITORY_SECRET + type: string + registry_type: + description: The registry type. + enum: + - maven_repository + type: string + username: + description: The username to use when authenticating with the private registry. + example: monalisa + type: string + nullable: true + visibility: + description: Which type of organization repositories have access to the + private registry. + enum: + - all + - private + - selected + type: string + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + required: + - name + - registry_type + - visibility + - created_at + - updated_at + org-private-registry-configuration-with-selected-repositories: + title: Organization private registry + description: Private registry configuration for an organization + type: object + properties: + name: + description: The name of the private registry configuration. + example: MAVEN_REPOSITORY_SECRET + type: string + registry_type: + description: The registry type. + enum: + - maven_repository + type: string + username: + description: The username to use when authenticating with the private registry. + example: monalisa + type: string + visibility: + description: Which type of organization repositories have access to the + private registry. `selected` means only the repositories specified by + `selected_repository_ids` can access the private registry. + enum: + - all + - private + - selected + type: string + selected_repository_ids: + type: array + description: An array of repository IDs that can access the organization + private registry when `visibility` is set to `selected`. + items: + type: integer + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + required: + - name + - registry_type + - visibility + - created_at + - updated_at project: title: Project description: Projects are a way to organize columns and cards of work. @@ -74739,6 +76198,13 @@ components: format: uri description: The URL that can be used to fetch, update, or delete info about this property via the API. + source_type: + type: string + description: The source type of the property + enum: + - organization + - enterprise + example: organization value_type: type: string example: single_select @@ -74784,6 +76250,47 @@ components: required: - property_name - value_type + custom-property-set-payload: + title: Custom Property Set Payload + description: Custom property set payload + type: object + properties: + value_type: + type: string + example: single_select + enum: + - string + - single_select + - multi_select + - true_false + description: The type of the value for the property + required: + type: boolean + description: Whether the property is required. + default_value: + oneOf: + - type: string + - type: array + items: + type: string + nullable: true + description: Default value of the property + description: + type: string + nullable: true + description: Short description of the property + allowed_values: + type: array + items: + type: string + maxLength: 75 + maxItems: 200 + nullable: true + description: |- + An ordered list of the allowed values of the property. + The property can have up to 200 allowed values. + required: + - value_type custom-property-value: title: Custom Property Value description: Custom property name and associated value @@ -75943,6 +77450,7 @@ components: Conditions for an organization ruleset. The branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties. The push rulesets conditions object does not require the `ref_name` property. + For repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`. oneOf: - type: object title: repository_name_and_ref_name @@ -76160,6 +77668,13 @@ components: parameters: type: object properties: + allowed_merge_methods: + type: array + description: When merging pull requests, you can allow any combination + of merge commits, squashing, or rebasing. At least one option must + be enabled. + items: + type: string dismiss_stale_reviews_on_push: type: boolean description: New, reviewable commits pushed will dismiss previous pull @@ -76665,12 +78180,14 @@ components: - branch - tag - push + - repository source_type: type: string description: The type of the source of the ruleset enum: - Repository - Organization + - Enterprise source: type: string description: The name of the source @@ -78429,6 +79946,8 @@ components: "$ref": "#/components/schemas/rate-limit" dependency_snapshots: "$ref": "#/components/schemas/rate-limit" + code_scanning_autofix: + "$ref": "#/components/schemas/rate-limit" required: - core - search @@ -80118,6 +81637,9 @@ components: signature: type: string nullable: true + verified_at: + type: string + nullable: true required: - verified - reason @@ -81134,6 +82656,60 @@ components: enum: - open - dismissed + code-scanning-autofix-status: + type: string + description: The status of an autofix. + enum: + - pending + - error + - success + - outdated + code-scanning-autofix-description: + type: string + description: The description of an autofix. + nullable: true + code-scanning-autofix-started-at: + type: string + description: 'The start time of an autofix in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' + format: date-time + readOnly: true + code-scanning-autofix: + type: object + properties: + status: + "$ref": "#/components/schemas/code-scanning-autofix-status" + description: + "$ref": "#/components/schemas/code-scanning-autofix-description" + started_at: + "$ref": "#/components/schemas/code-scanning-autofix-started-at" + required: + - status + - description + - started_at + code-scanning-autofix-commits: + description: Commit an autofix for a code scanning alert + type: object + properties: + target_ref: + description: The Git reference of target branch for the commit. Branch needs + to already exist. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" + in the Git documentation. + type: string + message: + description: Commit message to be used. + type: string + nullable: true + code-scanning-autofix-commits-response: + type: object + properties: + target_ref: + type: string + description: The Git reference of target branch for the commit. For more + information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" + in the Git documentation. + sha: + type: string + description: SHA of commit with autofix. code-scanning-analysis-sarif-id: type: string description: An identifier for the upload. @@ -81529,6 +83105,7 @@ components: items: type: string enum: + - actions - c-cpp - csharp - go @@ -81567,6 +83144,17 @@ components: enum: - configured - not-configured + runner_type: + description: Runner type to be used. + type: string + enum: + - standard + - labeled + runner_label: + nullable: true + description: Runner label to be used if the runner type is labeled. + type: string + example: code-scanning query_suite: description: CodeQL query suite to be used. type: string @@ -81579,6 +83167,7 @@ components: items: type: string enum: + - actions - c-cpp - csharp - go @@ -83242,6 +84831,9 @@ components: payload: type: string nullable: true + verified_at: + type: string + nullable: true secret-scanning-push-protection-bypass-placeholder-id: description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -84334,6 +85926,9 @@ components: payload: type: string nullable: true + verified_at: + type: string + nullable: true required: - verified - reason @@ -84913,6 +86508,8 @@ components: "$ref": "#/components/schemas/author-association" reactions: "$ref": "#/components/schemas/reaction-rollup" + sub_issues_summary: + "$ref": "#/components/schemas/sub-issues-summary" required: - assignee - closed_at @@ -86059,6 +87656,9 @@ components: payload: type: string nullable: true + verified_at: + type: string + nullable: true required: - verified - reason @@ -87954,6 +89554,21 @@ components: description: 'The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' nullable: true + push_protection_bypass_request_reviewer: + "$ref": "#/components/schemas/nullable-simple-user" + push_protection_bypass_request_reviewer_comment: + type: string + description: An optional comment when reviewing a push protection bypass. + nullable: true + push_protection_bypass_request_comment: + type: string + description: An optional comment when requesting a push protection bypass. + nullable: true + push_protection_bypass_request_html_url: + type: string + format: uri + description: The URL to a push protection bypass request. + nullable: true validity: type: string description: The token status as of the latest validity check. @@ -88155,7 +89770,7 @@ components: type: string format: uri description: The API URL to get the pull request where the secret was detected. - example: https://api.github.com/repos/octocat/Hello-World/pull/2846 + example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 required: - pull_request_title_url secret-scanning-location-pull-request-body: @@ -88168,7 +89783,7 @@ components: type: string format: uri description: The API URL to get the pull request where the secret was detected. - example: https://api.github.com/repos/octocat/Hello-World/pull/2846 + example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 required: - pull_request_body_url secret-scanning-location-pull-request-comment: @@ -88271,6 +89886,57 @@ components: token_type: type: string description: The token type this bypass is for. + secret-scanning-scan: + description: Information on a single scan performed by secret scanning on the + repository + type: object + properties: + type: + type: string + description: The type of scan + status: + type: string + description: The state of the scan. Either "completed", "running", or "pending" + completed_at: + type: string + format: date-time + description: The time that the scan was completed. Empty if the scan is + running + nullable: true + started_at: + type: string + format: date-time + description: The time that the scan was started. Empty if the scan is pending + nullable: true + secret-scanning-scan-history: + type: object + properties: + incremental_scans: + type: array + items: + "$ref": "#/components/schemas/secret-scanning-scan" + pattern_update_scans: + type: array + items: + "$ref": "#/components/schemas/secret-scanning-scan" + backfill_scans: + type: array + items: + "$ref": "#/components/schemas/secret-scanning-scan" + custom_pattern_backfill_scans: + type: array + items: + allOf: + - "$ref": "#/components/schemas/secret-scanning-scan" + - type: object + properties: + pattern_name: + type: string + description: Name of the custom pattern for custom pattern scans + pattern_scope: + type: string + description: Level at which the custom pattern is defined, one of + "repository", "organization", or "enterprise" repository-advisory-create: type: object properties: @@ -89085,6 +90751,20 @@ components: description: type: string nullable: true + sub_issues_summary: + title: Sub-issues Summary + type: object + properties: + total: + type: integer + completed: + type: integer + percent_completed: + type: integer + required: + - total + - completed + - percent_completed state: type: string state_reason: @@ -93834,6 +95514,20 @@ components: repository_url: type: string format: uri + sub_issues_summary: + title: Sub-issues Summary + type: object + properties: + total: + type: integer + completed: + type: integer + percent_completed: + type: integer + required: + - total + - completed + - percent_completed state: description: State of the issue; either 'open' or 'closed' type: string @@ -94869,6 +96563,20 @@ components: repository_url: type: string format: uri + sub_issues_summary: + title: Sub-issues Summary + type: object + properties: + total: + type: integer + completed: + type: integer + percent_completed: + type: integer + required: + - total + - completed + - percent_completed state: description: State of the issue; either 'open' or 'closed' type: string @@ -100500,6 +102208,21 @@ components: description: 'The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' nullable: true + push_protection_bypass_request_reviewer: + "$ref": "#/components/schemas/nullable-simple-user" + push_protection_bypass_request_reviewer_comment: + type: string + description: An optional comment when reviewing a push protection bypass. + nullable: true + push_protection_bypass_request_comment: + type: string + description: An optional comment when requesting a push protection bypass. + nullable: true + push_protection_bypass_request_html_url: + type: string + format: uri + description: The URL to a push protection bypass request. + nullable: true publicly_leaked: type: boolean description: Whether the detected secret was publicly leaked. @@ -112629,6 +114352,20 @@ components: repository_url: type: string format: uri + sub_issues_summary: + title: Sub-issues Summary + type: object + properties: + total: + type: integer + completed: + type: integer + percent_completed: + type: integer + required: + - total + - completed + - percent_completed state: description: State of the issue; either 'open' or 'closed' type: string @@ -113791,6 +115528,20 @@ components: repository_url: type: string format: uri + sub_issues_summary: + title: Sub-issues Summary + type: object + properties: + total: + type: integer + completed: + type: integer + percent_completed: + type: integer + required: + - total + - completed + - percent_completed state: description: State of the issue; either 'open' or 'closed' type: string @@ -114960,6 +116711,20 @@ components: repository_url: type: string format: uri + sub_issues_summary: + title: Sub-issues Summary + type: object + properties: + total: + type: integer + completed: + type: integer + percent_completed: + type: integer + required: + - total + - completed + - percent_completed state: description: State of the issue; either 'open' or 'closed' type: string @@ -116154,6 +117919,20 @@ components: repository_url: type: string format: uri + sub_issues_summary: + title: Sub-issues Summary + type: object + properties: + total: + type: integer + completed: + type: integer + percent_completed: + type: integer + required: + - total + - completed + - percent_completed state: description: State of the issue; either 'open' or 'closed' type: string @@ -117208,6 +118987,20 @@ components: repository_url: type: string format: uri + sub_issues_summary: + title: Sub-issues Summary + type: object + properties: + total: + type: integer + completed: + type: integer + percent_completed: + type: integer + required: + - total + - completed + - percent_completed state: description: State of the issue; either 'open' or 'closed' type: string @@ -118150,6 +119943,20 @@ components: repository_url: type: string format: uri + sub_issues_summary: + title: Sub-issues Summary + type: object + properties: + total: + type: integer + completed: + type: integer + percent_completed: + type: integer + required: + - total + - completed + - percent_completed state: description: State of the issue; either 'open' or 'closed' type: string @@ -119075,6 +120882,20 @@ components: repository_url: type: string format: uri + sub_issues_summary: + title: Sub-issues Summary + type: object + properties: + total: + type: integer + completed: + type: integer + percent_completed: + type: integer + required: + - total + - completed + - percent_completed state: description: State of the issue; either 'open' or 'closed' type: string @@ -120002,6 +121823,20 @@ components: repository_url: type: string format: uri + sub_issues_summary: + title: Sub-issues Summary + type: object + properties: + total: + type: integer + completed: + type: integer + percent_completed: + type: integer + required: + - total + - completed + - percent_completed state: description: State of the issue; either 'open' or 'closed' type: string @@ -120952,6 +122787,20 @@ components: repository_url: type: string format: uri + sub_issues_summary: + title: Sub-issues Summary + type: object + properties: + total: + type: integer + completed: + type: integer + percent_completed: + type: integer + required: + - total + - completed + - percent_completed state: description: State of the issue; either 'open' or 'closed' type: string @@ -121871,6 +123720,20 @@ components: repository_url: type: string format: uri + sub_issues_summary: + title: Sub-issues Summary + type: object + properties: + total: + type: integer + completed: + type: integer + percent_completed: + type: integer + required: + - total + - completed + - percent_completed state: description: State of the issue; either 'open' or 'closed' type: string @@ -122772,6 +124635,20 @@ components: repository_url: type: string format: uri + sub_issues_summary: + title: Sub-issues Summary + type: object + properties: + total: + type: integer + completed: + type: integer + percent_completed: + type: integer + required: + - total + - completed + - percent_completed state: description: State of the issue; either 'open' or 'closed' type: string @@ -124142,6 +126019,20 @@ components: repository_url: type: string format: uri + sub_issues_summary: + title: Sub-issues Summary + type: object + properties: + total: + type: integer + completed: + type: integer + percent_completed: + type: integer + required: + - total + - completed + - percent_completed state: description: State of the issue; either 'open' or 'closed' type: string @@ -125112,6 +127003,20 @@ components: repository_url: type: string format: uri + sub_issues_summary: + title: Sub-issues Summary + type: object + properties: + total: + type: integer + completed: + type: integer + percent_completed: + type: integer + required: + - total + - completed + - percent_completed state: description: State of the issue; either 'open' or 'closed' type: string @@ -126010,6 +127915,20 @@ components: repository_url: type: string format: uri + sub_issues_summary: + title: Sub-issues Summary + type: object + properties: + total: + type: integer + completed: + type: integer + percent_completed: + type: integer + required: + - total + - completed + - percent_completed state: description: State of the issue; either 'open' or 'closed' type: string @@ -127485,6 +129404,20 @@ components: repository_url: type: string format: uri + sub_issues_summary: + title: Sub-issues Summary + type: object + properties: + total: + type: integer + completed: + type: integer + percent_completed: + type: integer + required: + - total + - completed + - percent_completed state: description: State of the issue; either 'open' or 'closed' type: string @@ -188024,6 +189957,75 @@ components: - action - alert - repository + webhook-secret-scanning-scan-completed: + title: secret_scanning_scan completed event + type: object + properties: + action: + type: string + enum: + - completed + type: + type: string + description: What type of scan was completed + enum: + - backfill + - custom-pattern-backfill + - pattern-version-backfill + source: + type: string + description: What type of content was scanned + enum: + - git + - issues + - pull-requests + - discussions + - wiki + started_at: + type: string + format: date-time + description: 'The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' + completed_at: + type: string + format: date-time + description: 'The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' + secret_types: + type: array + description: List of patterns that were updated. This will be empty for + normal backfill scans or custom pattern updates + items: + type: string + nullable: true + custom_pattern_name: + type: string + description: If the scan was triggered by a custom pattern update, this + will be the name of the pattern that was updated + nullable: true + custom_pattern_scope: + type: string + description: If the scan was triggered by a custom pattern update, this + will be the scope of the pattern that was updated + enum: + - repository + - organization + - enterprise + nullable: true + repository: + "$ref": "#/components/schemas/repository-webhooks" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - source + - type + - started_at + - completed_at webhook-security-advisory-published: title: security_advisory published event type: object @@ -188670,6 +190672,9 @@ components: nullable: true verified: type: boolean + verified_at: + type: string + nullable: true required: - verified - reason @@ -197968,236 +199973,244 @@ components: zombie_man: https://github.githubassets.com/images/icons/emoji/unicode/1f9df-2642.png?v8 zombie_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f9df-2640.png?v8 zzz: https://github.githubassets.com/images/icons/emoji/unicode/1f4a4.png?v8 - copilot-seats-list: + enterprise-code-security-configuration-list: value: - total_seats: 2 - seats: - - created_at: '2021-08-03T18:00:00-06:00' - updated_at: '2021-09-23T15:00:00-06:00' - pending_cancellation_date: - last_activity_at: '2021-10-14T00:53:32-06:00' - last_activity_editor: vscode/1.77.3/copilot/1.86.82 - plan_type: business - assignee: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - assigning_team: - id: 1 - node_id: MDQ6VGVhbTE= - url: https://api.github.com/teams/1 - html_url: https://github.com/orgs/github/teams/justice-league - name: Justice League - slug: justice-league - description: A great team. - privacy: closed - notification_setting: notifications_enabled - permission: admin - members_url: https://api.github.com/teams/1/members{/member} - repositories_url: https://api.github.com/teams/1/repos - parent: - - created_at: '2021-09-23T18:00:00-06:00' - updated_at: '2021-09-23T15:00:00-06:00' - pending_cancellation_date: '2021-11-01' - last_activity_at: '2021-10-13T00:53:32-06:00' - last_activity_editor: vscode/1.77.3/copilot/1.86.82 - assignee: - login: octokitten - id: 1 - node_id: MDQ76VNlcjE= - avatar_url: https://github.com/images/error/octokitten_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octokitten - html_url: https://github.com/octokitten - followers_url: https://api.github.com/users/octokitten/followers - following_url: https://api.github.com/users/octokitten/following{/other_user} - gists_url: https://api.github.com/users/octokitten/gists{/gist_id} - starred_url: https://api.github.com/users/octokitten/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octokitten/subscriptions - organizations_url: https://api.github.com/users/octokitten/orgs - repos_url: https://api.github.com/users/octokitten/repos - events_url: https://api.github.com/users/octokitten/events{/privacy} - received_events_url: https://api.github.com/users/octokitten/received_events - type: User - site_admin: false - copilot-usage-metrics-for-day: + - id: 17 + target_type: global + name: GitHub recommended + description: Suggested settings for Dependabot, secret scanning, and code + scanning. + advanced_security: enabled + dependency_graph: enabled + dependency_graph_autosubmit_action: not_set + dependency_graph_autosubmit_action_options: + labeled_runners: false + dependabot_alerts: enabled + dependabot_security_updates: not_set + code_scanning_default_setup: enabled + code_scanning_default_setup_options: + runner_type: not_set + runner_label: + secret_scanning: enabled + secret_scanning_push_protection: enabled + secret_scanning_validity_checks: enabled + secret_scanning_non_provider_patterns: enabled + private_vulnerability_reporting: enabled + enforcement: enforced + url: https://api.github.com/enterprises/octo-enterprise/code-security/configurations/17 + html_url: https://github.com/organizations/octo-enterprise/settings/security_analysis/configurations/17/view + created_at: '2023-12-04T15:58:07Z' + updated_at: '2023-12-04T15:58:07Z' + - id: 1326 + target_type: enterprise + name: High risk settings + description: This is a code security configuration for octo-enterprise high + risk repositories + advanced_security: enabled + dependency_graph: enabled + dependency_graph_autosubmit_action: enabled + dependency_graph_autosubmit_action_options: + labeled_runners: false + dependabot_alerts: enabled + dependabot_security_updates: enabled + code_scanning_default_setup: enabled + code_scanning_default_setup_options: + runner_type: not_set + runner_label: + secret_scanning: enabled + secret_scanning_push_protection: enabled + secret_scanning_validity_checks: disabled + secret_scanning_non_provider_patterns: disabled + private_vulnerability_reporting: enabled + enforcement: enforced + url: https://api.github.com/enterprises/octo-enterprise/code-security/configurations/1326 + html_url: https://github.com/enterprises/octo-enterprise/settings/security_analysis/configurations/1326/edit + created_at: '2024-05-10T00:00:00Z' + updated_at: '2024-05-10T00:00:00Z' + enterprise-code-security-configuration: value: - - date: '2024-06-24' - total_active_users: 24 - total_engaged_users: 20 - copilot_ide_code_completions: - total_engaged_users: 20 - languages: - - name: python - total_engaged_users: 10 - - name: ruby - total_engaged_users: 10 - editors: - - name: vscode - total_engaged_users: 13 - models: - - name: default - is_custom_model: false - custom_model_training_date: - total_engaged_users: 13 - languages: - - name: python - total_engaged_users: 6 - total_code_suggestions: 249 - total_code_acceptances: 123 - total_code_lines_suggested: 225 - total_code_lines_accepted: 135 - - name: ruby - total_engaged_users: 7 - total_code_suggestions: 496 - total_code_acceptances: 253 - total_code_lines_suggested: 520 - total_code_lines_accepted: 270 - - name: neovim - total_engaged_users: 7 - models: - - name: a-custom-model - is_custom_model: true - custom_model_training_date: '2024-02-01' - languages: - - name: typescript - total_engaged_users: 3 - total_code_suggestions: 112 - total_code_acceptances: 56 - total_code_lines_suggested: 143 - total_code_lines_accepted: 61 - - name: go - total_engaged_users: 4 - total_code_suggestions: 132 - total_code_acceptances: 67 - total_code_lines_suggested: 154 - total_code_lines_accepted: 72 - copilot_ide_chat: - total_engaged_users: 13 - editors: - - name: vscode - total_engaged_users: 13 - models: - - name: default - is_custom_model: false - custom_model_training_date: - total_engaged_users: 12 - total_chats: 45 - total_chat_insertion_events: 12 - total_chat_copy_events: 16 - - name: a-custom-model - is_custom_model: true - custom_model_training_date: '2024-02-01' - total_engaged_users: 1 - total_chats: 10 - total_chat_insertion_events: 11 - total_chat_copy_events: 3 - copilot_dotcom_chat: - total_engaged_users: 14 - models: - - name: default - is_custom_model: false - custom_model_training_date: - total_engaged_users: 14 - total_chats: 38 - copilot_dotcom_pull_requests: - total_engaged_users: 12 - repositories: - - name: demo/repo1 - total_engaged_users: 8 - models: - - name: default - is_custom_model: false - custom_model_training_date: - total_pr_summaries_created: 6 - total_engaged_users: 8 - - name: demo/repo2 - total_engaged_users: 4 - models: - - name: a-custom-model - is_custom_model: true - custom_model_training_date: '2024-02-01' - total_pr_summaries_created: 10 - total_engaged_users: 4 - copilot-usage-metrics-enterprise: + id: 1325 + target_type: enterprise + name: High risk settings + description: This is a code security configuration for octo-enterprise + advanced_security: enabled + dependency_graph: enabled + dependency_graph_autosubmit_action: enabled + dependency_graph_autosubmit_action_options: + labeled_runners: false + dependabot_alerts: enabled + dependabot_security_updates: not_set + code_scanning_default_setup: disabled + secret_scanning: enabled + secret_scanning_push_protection: disabled + secret_scanning_delegated_bypass: disabled + secret_scanning_validity_checks: disabled + secret_scanning_non_provider_patterns: disabled + private_vulnerability_reporting: disabled + enforcement: enforced + url: https://api.github.com/enterprises/octo-enterprise/code-security/configurations/1325 + html_url: https://github.com/enterprises/octo-enterprise/settings/security_analysis/configurations/1325/edit + created_at: '2024-05-01T00:00:00Z' + updated_at: '2024-05-01T00:00:00Z' + code-security-default-configurations: value: - - day: '2023-10-15' - total_suggestions_count: 5000 - total_acceptances_count: 3000 - total_lines_suggested: 7000 - total_lines_accepted: 3500 - total_active_users: 15 - total_chat_acceptances: 45 - total_chat_turns: 350 - total_active_chat_users: 8 - breakdown: - - language: python - editor: vscode - suggestions_count: 3000 - acceptances_count: 2000 - lines_suggested: 3000 - lines_accepted: 1500 - active_users: 5 - - language: python - editor: jetbrains - suggestions_count: 1000 - acceptances_count: 500 - lines_suggested: 2000 - lines_accepted: 1000 - active_users: 5 - - language: javascript - editor: vscode - suggestions_count: 1000 - acceptances_count: 500 - lines_suggested: 2000 - lines_accepted: 1000 - active_users: 5 - - day: '2023-10-16' - total_suggestions_count: 5200 - total_acceptances_count: 5100 - total_lines_suggested: 5300 - total_lines_accepted: 5000 - total_active_users: 15 - total_chat_acceptances: 57 - total_chat_turns: 455 - total_active_chat_users: 12 - breakdown: - - language: python - editor: vscode - suggestions_count: 3100 - acceptances_count: 3000 - lines_suggested: 3200 - lines_accepted: 3100 - active_users: 5 - - language: python - editor: jetbrains - suggestions_count: 1100 - acceptances_count: 1000 - lines_suggested: 1200 - lines_accepted: 1100 - active_users: 5 - - language: javascript - editor: vscode - suggestions_count: 1000 - acceptances_count: 900 - lines_suggested: 1100 - lines_accepted: 1000 - active_users: 5 + - default_for_new_repos: public + configuration: + id: 1325 + target_type: organization + name: octo-org recommended settings + description: This is a code security configuration for octo-org + advanced_security: enabled + dependency_graph: enabled + dependency_graph_autosubmit_action: not_set + dependency_graph_autosubmit_action_options: + labeled_runners: false + dependabot_alerts: enabled + dependabot_security_updates: not_set + code_scanning_default_setup: enabled + code_scanning_default_setup_options: + runner_type: not_set + runner_label: + secret_scanning: enabled + secret_scanning_push_protection: enabled + secret_scanning_delegated_bypass: enabled + secret_scanning_delegated_bypass_options: + reviewers: + - security_configuration_id: 1325 + reviewer_id: 5678 + reviewer_type: TEAM + secret_scanning_validity_checks: enabled + secret_scanning_non_provider_patterns: enabled + private_vulnerability_reporting: enabled + enforcement: enforced + url: https://api.github.com/orgs/octo-org/code-security/configurations/1325 + html_url: https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325 + created_at: '2024-05-01T00:00:00Z' + updated_at: '2024-05-01T00:00:00Z' + - default_for_new_repos: private_and_internal + configuration: + id: 17 + target_type: global + name: GitHub recommended + description: Suggested settings for Dependabot, secret scanning, and code + scanning. + advanced_security: enabled + dependency_graph: enabled + dependency_graph_autosubmit_action: not_set + dependency_graph_autosubmit_action_options: + labeled_runners: false + dependabot_alerts: enabled + dependabot_security_updates: not_set + code_scanning_default_setup: enabled + code_scanning_default_setup_options: + runner_type: not_set + runner_label: + secret_scanning: enabled + secret_scanning_push_protection: enabled + secret_scanning_delegated_bypass: disabled + secret_scanning_validity_checks: disabled + private_vulnerability_reporting: enabled + enforcement: enforced + url: https://api.github.com/orgs/octo-org/code-security/configurations/17 + html_url: https://github.com/organizations/octo-org/settings/security_products/configurations/view + created_at: '2023-12-04T15:58:07Z' + updated_at: '2023-12-04T15:58:07Z' + code-security-configuration: + value: + id: 1325 + target_type: organization + name: octo-org recommended settings + description: This is a code security configuration for octo-org + advanced_security: enabled + dependency_graph: enabled + dependency_graph_autosubmit_action: enabled + dependency_graph_autosubmit_action_options: + labeled_runners: false + dependabot_alerts: enabled + dependabot_security_updates: not_set + code_scanning_default_setup: disabled + code_scanning_default_setup_options: + runner_type: not_set + runner_label: + secret_scanning: enabled + secret_scanning_push_protection: disabled + secret_scanning_delegated_bypass: disabled + secret_scanning_validity_checks: disabled + secret_scanning_non_provider_patterns: disabled + private_vulnerability_reporting: disabled + enforcement: enforced + url: https://api.github.com/orgs/octo-org/code-security/configurations/1325 + html_url: https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325 + created_at: '2024-05-01T00:00:00Z' + updated_at: '2024-05-01T00:00:00Z' + simple-repository: + value: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + hooks_url: http://api.github.com/repos/octocat/Hello-World/hooks dependabot-alerts-for-organization: value: - number: 2 @@ -198627,6 +200640,28 @@ components: site_admin: true push_protection_bypassed: true push_protection_bypassed_at: '2020-11-06T21:48:51Z' + push_protection_bypass_request_reviewer: + login: octocat + id: 3 + node_id: MDQ6VXNlcjI= + avatar_url: https://alambic.github.com/avatars/u/3? + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: true + push_protection_bypass_request_reviewer_comment: Example response + push_protection_bypass_request_comment: Example comment + push_protection_bypass_request_html_url: https://github.com/owner/repo/secret_scanning_exemptions/1 resolution_comment: Example comment validity: active publicly_leaked: false @@ -198711,74 +200746,14 @@ components: push_protection_bypassed_by: push_protection_bypassed: false push_protection_bypassed_at: + push_protection_bypass_request_reviewer: + push_protection_bypass_request_reviewer_comment: + push_protection_bypass_request_comment: + push_protection_bypass_request_html_url: resolution_comment: validity: unknown publicly_leaked: false multi_repo: false - copilot-usage-metrics-org: - value: - - day: '2023-10-15' - total_suggestions_count: 1000 - total_acceptances_count: 800 - total_lines_suggested: 1800 - total_lines_accepted: 1200 - total_active_users: 10 - total_chat_acceptances: 32 - total_chat_turns: 200 - total_active_chat_users: 4 - breakdown: - - language: python - editor: vscode - suggestions_count: 300 - acceptances_count: 250 - lines_suggested: 900 - lines_accepted: 700 - active_users: 5 - - language: python - editor: jetbrains - suggestions_count: 300 - acceptances_count: 200 - lines_suggested: 400 - lines_accepted: 300 - active_users: 2 - - language: ruby - editor: vscode - suggestions_count: 400 - acceptances_count: 350 - lines_suggested: 500 - lines_accepted: 200 - active_users: 3 - - day: '2023-10-16' - total_suggestions_count: 800 - total_acceptances_count: 600 - total_lines_suggested: 1100 - total_lines_accepted: 700 - total_active_users: 12 - total_chat_acceptances: 57 - total_chat_turns: 426 - total_active_chat_users: 8 - breakdown: - - language: python - editor: vscode - suggestions_count: 300 - acceptances_count: 200 - lines_suggested: 600 - lines_accepted: 300 - active_users: 2 - - language: python - editor: jetbrains - suggestions_count: 300 - acceptances_count: 150 - lines_suggested: 300 - lines_accepted: 250 - active_users: 6 - - language: ruby - editor: vscode - suggestions_count: 200 - acceptances_count: 150 - lines_suggested: 200 - lines_accepted: 150 - active_users: 3 public-events-items: value: - id: '22249084947' @@ -200185,6 +202160,20 @@ components: public_members_url: https://api.github.com/orgs/github/public_members{/member} avatar_url: https://github.com/images/error/octocat_happy.gif description: A great organization + billing-usage-report: + value: + usageItems: + - date: '2023-08-01' + product: Actions + sku: Actions Linux + quantity: 100 + unitType: minutes + pricePerUnit: 0.008 + grossAmount: 0.8 + discountAmount: 0 + netAmount: 0.8 + organizationName: GitHub + repositoryName: github/example organization-full: value: login: github @@ -201367,88 +203356,6 @@ components: html_url: https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1326 created_at: '2024-05-10T00:00:00Z' updated_at: '2024-05-10T00:00:00Z' - code-security-configuration: - value: - id: 1325 - target_type: organization - name: octo-org recommended settings - description: This is a code security configuration for octo-org - advanced_security: enabled - dependency_graph: enabled - dependency_graph_autosubmit_action: enabled - dependency_graph_autosubmit_action_options: - labeled_runners: false - dependabot_alerts: enabled - dependabot_security_updates: not_set - code_scanning_default_setup: disabled - secret_scanning: enabled - secret_scanning_push_protection: disabled - secret_scanning_delegated_bypass: disabled - secret_scanning_validity_checks: disabled - secret_scanning_non_provider_patterns: disabled - private_vulnerability_reporting: disabled - enforcement: enforced - url: https://api.github.com/orgs/octo-org/code-security/configurations/1325 - html_url: https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325 - created_at: '2024-05-01T00:00:00Z' - updated_at: '2024-05-01T00:00:00Z' - code-security-default-configurations: - value: - - default_for_new_repos: public - configuration: - id: 1325 - target_type: organization - name: octo-org recommended settings - description: This is a code security configuration for octo-org - advanced_security: enabled - dependency_graph: enabled - dependency_graph_autosubmit_action: not_set - dependency_graph_autosubmit_action_options: - labeled_runners: false - dependabot_alerts: enabled - dependabot_security_updates: not_set - code_scanning_default_setup: enabled - secret_scanning: enabled - secret_scanning_push_protection: enabled - secret_scanning_delegated_bypass: enabled - secret_scanning_delegated_bypass_options: - reviewers: - - security_configuration_id: 1325 - reviewer_id: 5678 - reviewer_type: TEAM - secret_scanning_validity_checks: enabled - secret_scanning_non_provider_patterns: enabled - private_vulnerability_reporting: enabled - enforcement: enforced - url: https://api.github.com/orgs/octo-org/code-security/configurations/1325 - html_url: https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325 - created_at: '2024-05-01T00:00:00Z' - updated_at: '2024-05-01T00:00:00Z' - - default_for_new_repos: private_and_internal - configuration: - id: 17 - target_type: global - name: GitHub recommended - description: Suggested settings for Dependabot, secret scanning, and code - scanning. - advanced_security: enabled - dependency_graph: enabled - dependency_graph_autosubmit_action: not_set - dependency_graph_autosubmit_action_options: - labeled_runners: false - dependabot_alerts: enabled - dependabot_security_updates: not_set - code_scanning_default_setup: enabled - secret_scanning: enabled - secret_scanning_push_protection: enabled - secret_scanning_delegated_bypass: disabled - secret_scanning_validity_checks: disabled - private_vulnerability_reporting: enabled - enforcement: enforced - url: https://api.github.com/orgs/octo-org/code-security/configurations/17 - html_url: https://github.com/organizations/octo-org/settings/security_products/configurations/view - created_at: '2023-12-04T15:58:07Z' - updated_at: '2023-12-04T15:58:07Z' code-security-configuration-updated: value: id: 1325 @@ -201463,6 +203370,9 @@ components: dependabot_alerts: enabled dependabot_security_updates: not_set code_scanning_default_setup: enabled + code_scanning_default_setup_options: + runner_type: not_set + runner_label: secret_scanning: disabled secret_scanning_push_protection: disabled secret_scanning_delegated_bypass: disabled @@ -201474,74 +203384,6 @@ components: html_url: https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325 created_at: '2024-05-01T00:00:00Z' updated_at: '2024-05-01T00:00:00Z' - simple-repository: - value: - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: Hello-World - full_name: octocat/Hello-World - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - private: false - html_url: https://github.com/octocat/Hello-World - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World - archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads - events_url: https://api.github.com/repos/octocat/Hello-World/events - forks_url: https://api.github.com/repos/octocat/Hello-World/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - git_url: git:github.com/octocat/Hello-World.git - issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} - keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} - languages_url: https://api.github.com/repos/octocat/Hello-World/languages - merges_url: https://api.github.com/repos/octocat/Hello-World/merges - milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} - releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} - ssh_url: git@github.com:octocat/Hello-World.git - stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers - statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers - subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription - tags_url: https://api.github.com/repos/octocat/Hello-World/tags - teams_url: https://api.github.com/repos/octocat/Hello-World/teams - trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - hooks_url: http://api.github.com/repos/octocat/Hello-World/hooks codespaces-list: value: total_count: 3 @@ -201988,6 +203830,236 @@ components: cli: enabled public_code_suggestions: block plan_type: business + copilot-seats-list: + value: + total_seats: 2 + seats: + - created_at: '2021-08-03T18:00:00-06:00' + updated_at: '2021-09-23T15:00:00-06:00' + pending_cancellation_date: + last_activity_at: '2021-10-14T00:53:32-06:00' + last_activity_editor: vscode/1.77.3/copilot/1.86.82 + plan_type: business + assignee: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + assigning_team: + id: 1 + node_id: MDQ6VGVhbTE= + url: https://api.github.com/teams/1 + html_url: https://github.com/orgs/github/teams/justice-league + name: Justice League + slug: justice-league + description: A great team. + privacy: closed + notification_setting: notifications_enabled + permission: admin + members_url: https://api.github.com/teams/1/members{/member} + repositories_url: https://api.github.com/teams/1/repos + parent: + - created_at: '2021-09-23T18:00:00-06:00' + updated_at: '2021-09-23T15:00:00-06:00' + pending_cancellation_date: '2021-11-01' + last_activity_at: '2021-10-13T00:53:32-06:00' + last_activity_editor: vscode/1.77.3/copilot/1.86.82 + assignee: + login: octokitten + id: 1 + node_id: MDQ76VNlcjE= + avatar_url: https://github.com/images/error/octokitten_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octokitten + html_url: https://github.com/octokitten + followers_url: https://api.github.com/users/octokitten/followers + following_url: https://api.github.com/users/octokitten/following{/other_user} + gists_url: https://api.github.com/users/octokitten/gists{/gist_id} + starred_url: https://api.github.com/users/octokitten/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octokitten/subscriptions + organizations_url: https://api.github.com/users/octokitten/orgs + repos_url: https://api.github.com/users/octokitten/repos + events_url: https://api.github.com/users/octokitten/events{/privacy} + received_events_url: https://api.github.com/users/octokitten/received_events + type: User + site_admin: false + copilot-usage-metrics-for-day: + value: + - date: '2024-06-24' + total_active_users: 24 + total_engaged_users: 20 + copilot_ide_code_completions: + total_engaged_users: 20 + languages: + - name: python + total_engaged_users: 10 + - name: ruby + total_engaged_users: 10 + editors: + - name: vscode + total_engaged_users: 13 + models: + - name: default + is_custom_model: false + custom_model_training_date: + total_engaged_users: 13 + languages: + - name: python + total_engaged_users: 6 + total_code_suggestions: 249 + total_code_acceptances: 123 + total_code_lines_suggested: 225 + total_code_lines_accepted: 135 + - name: ruby + total_engaged_users: 7 + total_code_suggestions: 496 + total_code_acceptances: 253 + total_code_lines_suggested: 520 + total_code_lines_accepted: 270 + - name: neovim + total_engaged_users: 7 + models: + - name: a-custom-model + is_custom_model: true + custom_model_training_date: '2024-02-01' + languages: + - name: typescript + total_engaged_users: 3 + total_code_suggestions: 112 + total_code_acceptances: 56 + total_code_lines_suggested: 143 + total_code_lines_accepted: 61 + - name: go + total_engaged_users: 4 + total_code_suggestions: 132 + total_code_acceptances: 67 + total_code_lines_suggested: 154 + total_code_lines_accepted: 72 + copilot_ide_chat: + total_engaged_users: 13 + editors: + - name: vscode + total_engaged_users: 13 + models: + - name: default + is_custom_model: false + custom_model_training_date: + total_engaged_users: 12 + total_chats: 45 + total_chat_insertion_events: 12 + total_chat_copy_events: 16 + - name: a-custom-model + is_custom_model: true + custom_model_training_date: '2024-02-01' + total_engaged_users: 1 + total_chats: 10 + total_chat_insertion_events: 11 + total_chat_copy_events: 3 + copilot_dotcom_chat: + total_engaged_users: 14 + models: + - name: default + is_custom_model: false + custom_model_training_date: + total_engaged_users: 14 + total_chats: 38 + copilot_dotcom_pull_requests: + total_engaged_users: 12 + repositories: + - name: demo/repo1 + total_engaged_users: 8 + models: + - name: default + is_custom_model: false + custom_model_training_date: + total_pr_summaries_created: 6 + total_engaged_users: 8 + - name: demo/repo2 + total_engaged_users: 4 + models: + - name: a-custom-model + is_custom_model: true + custom_model_training_date: '2024-02-01' + total_pr_summaries_created: 10 + total_engaged_users: 4 + copilot-usage-metrics-org: + value: + - day: '2023-10-15' + total_suggestions_count: 1000 + total_acceptances_count: 800 + total_lines_suggested: 1800 + total_lines_accepted: 1200 + total_active_users: 10 + total_chat_acceptances: 32 + total_chat_turns: 200 + total_active_chat_users: 4 + breakdown: + - language: python + editor: vscode + suggestions_count: 300 + acceptances_count: 250 + lines_suggested: 900 + lines_accepted: 700 + active_users: 5 + - language: python + editor: jetbrains + suggestions_count: 300 + acceptances_count: 200 + lines_suggested: 400 + lines_accepted: 300 + active_users: 2 + - language: ruby + editor: vscode + suggestions_count: 400 + acceptances_count: 350 + lines_suggested: 500 + lines_accepted: 200 + active_users: 3 + - day: '2023-10-16' + total_suggestions_count: 800 + total_acceptances_count: 600 + total_lines_suggested: 1100 + total_lines_accepted: 700 + total_active_users: 12 + total_chat_acceptances: 57 + total_chat_turns: 426 + total_active_chat_users: 8 + breakdown: + - language: python + editor: vscode + suggestions_count: 300 + acceptances_count: 200 + lines_suggested: 600 + lines_accepted: 300 + active_users: 2 + - language: python + editor: jetbrains + suggestions_count: 300 + acceptances_count: 150 + lines_suggested: 300 + lines_accepted: 250 + active_users: 6 + - language: ruby + editor: vscode + suggestions_count: 200 + acceptances_count: 150 + lines_suggested: 200 + lines_accepted: 150 + active_users: 3 organization-dependabot-secret-paginated: value: total_count: 3 @@ -203403,6 +205475,39 @@ components: token_expired: false token_expires_at: '2023-11-16T08:47:09.000-07:00' token_last_used_at: + org-private-registry-configurations-paginated: + value: + total_count: 1 + configurations: + - name: MAVEN_REPOSITORY_SECRET + registry_type: maven_repository + username: monalisa + created_at: '2019-08-10T14:59:22Z' + updated_at: '2020-01-10T14:59:22Z' + visibility: selected + org-private-registry-configuration: + value: + name: MAVEN_REPOSITORY_SECRET + registry_type: maven_repository + username: monalisa + visibility: private + created_at: '2019-08-10T14:59:22Z' + updated_at: '2020-01-10T14:59:22Z' + org-private-registry-configuration-with-selected-repositories: + value: + name: MAVEN_REPOSITORY_SECRET + registry_type: maven_repository + username: monalisa + visibility: selected + selected_repository_ids: + - 1296269 + - 1296280 + created_at: '2019-08-10T14:59:22Z' + updated_at: '2020-01-10T14:59:22Z' + private-registries-public-key: + value: + key_id: '012345678912345678' + key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 project-items: value: - owner_url: https://api.github.com/orgs/octocat @@ -203475,6 +205580,7 @@ components: value: - property_name: environment url: https://api.github.com/orgs/github/properties/schema/environment + source_type: organization value_type: single_select required: true default_value: production @@ -203485,15 +205591,18 @@ components: values_editable_by: org_actors - property_name: service url: https://api.github.com/orgs/github/properties/schema/service + source_type: organization value_type: string - property_name: team url: https://api.github.com/orgs/github/properties/schema/team + source_type: organization value_type: string description: Team owning the repository custom-property: value: property_name: environment url: https://api.github.com/orgs/github/properties/schema/environment + source_type: organization value_type: single_select required: true default_value: production @@ -205316,6 +207425,11 @@ components: used: 0 remaining: 10 reset: 1691591091 + code_scanning_autofix: + limit: 10 + used: 0 + remaining: 10 + reset: 1691591091 rate: limit: 5000 used: 1 @@ -206861,6 +208975,7 @@ components: reason: unsigned signature: payload: + verified_at: url: https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d html_url: https://github.com/octocat/Hello-World/commit/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d comments_url: https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d/comments @@ -207366,6 +209481,7 @@ components: reason: unsigned signature: payload: + verified_at: comment_count: 0 author: gravatar_id: '' @@ -208503,6 +210619,29 @@ components: classifications: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances + code-scanning-autofix: + value: + status: success + description: This fixes an XSS vulnerability by escaping the user input. + started_at: '2024-02-14T12:29:18Z' + code-scanning-bad-request: + value: + message: The alert_number is not valid + documentation_url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert + status: '400' + code-scanning-autofix-pending: + value: + status: pending + description: + started_at: '2024-02-14T12:29:18Z' + code-scanning-autofix-commits: + value: + target_ref: refs/heads/fix-bug + message: "Let's fix this \U0001FAB2!" + code-scanning-autofix-commits-response: + value: + target_ref: refs/heads/main + sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 code-scanning-alert-instances: value: - ref: refs/heads/main @@ -209638,6 +211777,7 @@ components: reason: unsigned signature: payload: + verified_at: author: login: octocat id: 1 @@ -210191,6 +212331,7 @@ components: reason: unsigned signature: payload: + verified_at: author: login: octocat id: 1 @@ -210613,6 +212754,7 @@ components: reason: unsigned signature: payload: + verified_at: author: login: octocat id: 1 @@ -210680,6 +212822,7 @@ components: reason: unsigned signature: payload: + verified_at: author: login: octocat id: 1 @@ -210751,6 +212894,7 @@ components: reason: unsigned signature: payload: + verified_at: author: login: octocat id: 1 @@ -210973,6 +213117,7 @@ components: reason: unsigned signature: payload: + verified_at: file-commit-example-for-creating-a-file: value: content: @@ -211015,6 +213160,7 @@ components: reason: unsigned signature: payload: + verified_at: file-commit: value: content: @@ -211044,6 +213190,7 @@ components: reason: unsigned signature: payload: + verified_at: contributor-items-response-if-repository-contains-content: value: - login: octocat @@ -212083,6 +214230,7 @@ components: reason: unsigned signature: payload: + verified_at: html_url: https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd git-commit-2: value: @@ -212111,6 +214259,7 @@ components: reason: unsigned signature: payload: + verified_at: git-ref-items: value: - ref: refs/heads/feature-a @@ -212156,6 +214305,7 @@ components: reason: unsigned signature: payload: + verified_at: git-tree: value: sha: cd8274d15fa3ae2ab983129fb037999f264ba9a7 @@ -216230,6 +218380,28 @@ components: site_admin: true push_protection_bypassed: true push_protection_bypassed_at: '2020-11-06T21:48:51Z' + push_protection_bypass_request_reviewer: + login: octocat + id: 3 + node_id: MDQ6VXNlcjI= + avatar_url: https://alambic.github.com/avatars/u/3? + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: true + push_protection_bypass_request_reviewer_comment: Example response + push_protection_bypass_request_comment: Example comment + push_protection_bypass_request_html_url: https://github.com/owner/repo/secret_scanning_exemptions/1 resolution_comment: Example comment validity: inactive publicly_leaked: false @@ -216249,6 +218421,10 @@ components: push_protection_bypassed_by: push_protection_bypassed: false push_protection_bypassed_at: + push_protection_bypass_request_reviewer: + push_protection_bypass_request_reviewer_comment: + push_protection_bypass_request_comment: + push_protection_bypass_request_html_url: resolution_comment: validity: unknown publicly_leaked: false @@ -216270,6 +218446,10 @@ components: push_protection_bypassed_by: push_protection_bypassed: false push_protection_bypassed_at: + push_protection_bypass_request_reviewer: + push_protection_bypass_request_reviewer_comment: + push_protection_bypass_request_comment: + push_protection_bypass_request_html_url: resolution_comment: validity: unknown publicly_leaked: false @@ -216309,6 +218489,10 @@ components: push_protection_bypassed: false push_protection_bypassed_by: push_protection_bypassed_at: + push_protection_bypass_request_reviewer: + push_protection_bypass_request_reviewer_comment: + push_protection_bypass_request_comment: + push_protection_bypass_request_html_url: resolution_comment: Example comment validity: unknown publicly_leaked: false @@ -216357,7 +218541,7 @@ components: discussion_comment_url: https://github.com/community/community/discussions/39082#discussioncomment-4158232 - type: pull_request_title details: - pull_request_title_url: https://api.github.com/repos/octocat/Hello-World/pull/2846 + pull_request_title_url: https://api.github.com/repos/octocat/Hello-World/pulls/2846 - type: pull_request_body details: pull_request_body_url: https://api.github.com/repos/octocat/Hello-World/pulls/2846 @@ -216375,6 +218559,43 @@ components: reason: will_fix_later expire_at: '2020-11-06T18:18:30Z' token_type: mailchimp_api_key + secret-scanning-scan-history: + value: + incremental_scans: + - type: git + status: completed + completed_at: '2024-10-07T02:47:00Z' + backfill_scans: + - type: git + status: completed + started_at: '2024-10-07T02:47:00Z' + completed_at: '2024-10-07T02:50:00Z' + - type: issue + status: completed + started_at: '2024-10-07T02:47:00Z' + completed_at: '2024-10-07T02:49:00Z' + - type: discussion + status: completed + started_at: '2024-10-07T02:47:00Z' + completed_at: '2024-10-07T02:48:00Z' + pattern_update_scans: + - type: discussion + status: in_progress + started_at: '2024-10-07T02:47:00Z' + completed_at: '2024-10-07T02:51:00Z' + custom_pattern_backfill_scans: + - type: git + status: completed + started_at: '2024-10-07T02:47:00Z' + completed_at: '2024-10-07T02:55:00Z' + pattern_slug: my-custom-pattern + pattern_scope: enterprise + - type: git + status: completed + started_at: '2024-10-07T02:47:00Z' + completed_at: '2024-10-07T02:55:00Z' + pattern_slug: my-custom-pattern + pattern_scope: organization repository-advisory: value: ghsa_id: GHSA-abcd-1234-efgh @@ -222184,6 +224405,13 @@ components: required: true schema: type: string + configuration-id: + name: configuration_id + description: The unique identifier of the code security configuration. + in: path + required: true + schema: + type: integer dependabot-alert-comma-separated-states: name: state in: query @@ -222280,9 +224508,9 @@ components: secret-scanning-alert-secret-type: name: secret_type in: query - description: |- - A comma-separated list of secret types to return. By default all secret types are returned. - See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" + description: A comma-separated list of secret types to return. All default secret + patterns are returned. To return experimental patterns, pass the token name(s) + in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. required: false schema: @@ -222335,20 +224563,6 @@ components: schema: type: boolean default: false - enterprise-team-slug: - name: team_slug - description: The slug of the enterprise team name. - in: path - required: true - schema: - type: string - team-slug: - name: team_slug - description: The slug of the team name. - in: path - required: true - schema: - type: string gist-id: name: gist_id description: The unique identifier of the gist. @@ -222462,6 +224676,39 @@ components: required: true schema: type: string + billing-usage-report-year: + name: year + description: If specified, only return results for a single year. The value + of `year` is an integer with four digits representing a year. For example, + `2024`. Default value is the current year. + in: query + required: false + schema: + type: integer + billing-usage-report-month: + name: month + description: If specified, only return results for a single month. The value + of `month` is an integer between `1` and `12`. + in: query + required: false + schema: + type: integer + billing-usage-report-day: + name: day + description: If specified, only return results for a single day. The value of + `day` is an integer between `1` and `31`. + in: query + required: false + schema: + type: integer + billing-usage-report-hour: + name: hour + description: If specified, only return results for a single hour. The value + of `hour` is an integer between `0` and `23`. + in: query + required: false + schema: + type: integer repository-id: name: repository_id description: The unique identifier of the repository. @@ -222545,13 +224792,6 @@ components: required: false schema: "$ref": "#/components/schemas/code-scanning-analysis-tool-guid" - configuration-id: - name: configuration_id - description: The unique identifier of the code security configuration. - in: path - required: true - schema: - type: integer hook-id: name: hook_id description: The unique identifier of the hook. You can find this value in the @@ -222568,11 +224808,11 @@ components: schema: type: string enum: - - installations - - classic_pats - - fine_grained_pats - - oauth_apps - - github_apps_user_to_server + - installation + - classic_pat + - fine_grained_pat + - oauth_app + - github_app_user_to_server api-insights-actor-id: name: actor_id in: path @@ -222582,16 +224822,19 @@ components: type: integer api-insights-min-timestamp: name: min_timestamp - description: The minimum timestamp to query for stats + description: 'The minimum timestamp to query for stats. This is a timestamp + in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: true schema: type: string api-insights-max-timestamp: name: max_timestamp - description: The maximum timestamp to query for stats + description: 'The maximum timestamp to query for stats. Defaults to the time + 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + format: `YYYY-MM-DDTHH:MM:SSZ`.' in: query - required: true + required: false schema: type: string api-insights-route-stats-sort: @@ -222611,6 +224854,14 @@ components: - api_route - total_request_count default: total_request_count + api-insights-api-route-substring: + name: api_route_substring + in: query + description: Providing a substring will filter results where the API route contains + the substring. This is a case-insensitive search. + required: false + schema: + type: string api-insights-sort: name: sort description: The property to sort the results by. @@ -222627,6 +224878,14 @@ components: - subject_name - total_request_count default: total_request_count + api-insights-subject-name-substring: + name: subject_name_substring + in: query + description: Providing a substring will filter results where the subject name + contains the substring. This is a case-insensitive search. + required: false + schema: + type: string api-insights-user-id: name: user_id in: path @@ -222642,6 +224901,14 @@ components: required: true schema: type: string + api-insights-actor-name-substring: + name: actor_name_substring + in: query + description: Providing a substring will filter results where the actor name + contains the substring. This is a case-insensitive search. + required: false + schema: + type: string invitation-id: name: invitation_id description: The unique identifier of the invitation. @@ -222670,6 +224937,13 @@ components: required: true schema: type: string + team-slug: + name: team_slug + description: The slug of the team name. + in: path + required: true + schema: + type: string role-id: name: role_id description: The unique identifier of the role. @@ -222818,11 +225092,10 @@ components: x-multi-segment: true repository-name-in-query: name: repository_name - description: The name of the repository to filter on. When specified, only rule - evaluations from this repository will be returned. + description: The name of the repository to filter on. in: query schema: - type: integer + type: string time-period: name: time_period description: |- @@ -223509,19 +225782,14 @@ components: application/json: schema: "$ref": "#/components/schemas/basic-error" - internal_error: - description: Internal Error - content: - application/json: - schema: - "$ref": "#/components/schemas/basic-error" - usage_metrics_api_disabled: - description: Copilot Usage Merics API setting is disabled at the organization - or enterprise level. + conflict: + description: Conflict content: application/json: schema: "$ref": "#/components/schemas/basic-error" + no_content: + description: A header with no content is returned. service_unavailable: description: Service unavailable content: @@ -223562,8 +225830,17 @@ components: application/json: schema: "$ref": "#/components/schemas/basic-error" - conflict: - description: Conflict + billing_usage_report_org: + description: Billing usage report response for an organization + content: + application/json: + schema: + "$ref": "#/components/schemas/billing-usage-report" + examples: + default: + "$ref": "#/components/examples/billing-usage-report" + internal_error: + description: Internal Error content: application/json: schema: @@ -223624,8 +225901,13 @@ components: examples: default: "$ref": "#/components/examples/runner-labels-readonly" - no_content: - description: A header with no content is returned. + usage_metrics_api_disabled: + description: Copilot Usage Merics API setting is disabled at the organization + or enterprise level. + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" package_es_list_error: description: The value of `per_page` multiplied by `page` cannot be greater than 10000. @@ -223654,6 +225936,22 @@ components: application/json: schema: "$ref": "#/components/schemas/basic-error" + code_scanning_bad_request: + description: Bad Request + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" + examples: + default: + "$ref": "#/components/examples/code-scanning-bad-request" + code_scanning_autofix_create_forbidden: + description: Response if the repository is archived, if GitHub Advanced Security + is not enabled for this repository or if rate limit is exceeded + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" found: description: Found code_scanning_conflict: diff --git a/packages/openapi-typescript/examples/stripe-api.ts b/packages/openapi-typescript/examples/stripe-api.ts index f8237c017..a1d3a6337 100644 --- a/packages/openapi-typescript/examples/stripe-api.ts +++ b/packages/openapi-typescript/examples/stripe-api.ts @@ -872,7 +872,7 @@ export interface paths { }; /** * Retrieve the credit balance summary for a customer - * @description

Retrieves the credit balance summary for a customer

+ * @description

Retrieves the credit balance summary for a customer.

*/ get: operations["GetBillingCreditBalanceSummary"]; put?: never; @@ -892,7 +892,7 @@ export interface paths { }; /** * List credit balance transactions - * @description

Retrieve a list of credit balance transactions

+ * @description

Retrieve a list of credit balance transactions.

*/ get: operations["GetBillingCreditBalanceTransactions"]; put?: never; @@ -912,7 +912,7 @@ export interface paths { }; /** * Retrieve a credit balance transaction - * @description

Retrieves a credit balance transaction

+ * @description

Retrieves a credit balance transaction.

*/ get: operations["GetBillingCreditBalanceTransactionsId"]; put?: never; @@ -938,7 +938,7 @@ export interface paths { put?: never; /** * Create a credit grant - * @description

Creates a credit grant

+ * @description

Creates a credit grant.

*/ post: operations["PostBillingCreditGrants"]; delete?: never; @@ -956,13 +956,13 @@ export interface paths { }; /** * Retrieve a credit grant - * @description

Retrieves a credit grant

+ * @description

Retrieves a credit grant.

*/ get: operations["GetBillingCreditGrantsId"]; put?: never; /** * Update a credit grant - * @description

Updates a credit grant

+ * @description

Updates a credit grant.

*/ post: operations["PostBillingCreditGrantsId"]; delete?: never; @@ -1022,7 +1022,7 @@ export interface paths { put?: never; /** * Create a billing meter event adjustment - * @description

Creates a billing meter event adjustment

+ * @description

Creates a billing meter event adjustment.

*/ post: operations["PostBillingMeterEventAdjustments"]; delete?: never; @@ -1042,7 +1042,7 @@ export interface paths { put?: never; /** * Create a billing meter event - * @description

Creates a billing meter event

+ * @description

Creates a billing meter event.

*/ post: operations["PostBillingMeterEvents"]; delete?: never; @@ -1066,7 +1066,7 @@ export interface paths { put?: never; /** * Create a billing meter - * @description

Creates a billing meter

+ * @description

Creates a billing meter.

*/ post: operations["PostBillingMeters"]; delete?: never; @@ -1084,13 +1084,13 @@ export interface paths { }; /** * Retrieve a billing meter - * @description

Retrieves a billing meter given an ID

+ * @description

Retrieves a billing meter given an ID.

*/ get: operations["GetBillingMetersId"]; put?: never; /** * Update a billing meter - * @description

Updates a billing meter

+ * @description

Updates a billing meter.

*/ post: operations["PostBillingMetersId"]; delete?: never; @@ -1110,7 +1110,7 @@ export interface paths { put?: never; /** * Deactivate a billing meter - * @description

Deactivates a billing meter

+ * @description

When a meter is deactivated, no more meter events will be accepted for this meter. You can’t attach a deactivated meter to a price.

*/ post: operations["PostBillingMetersIdDeactivate"]; delete?: never; @@ -1150,7 +1150,7 @@ export interface paths { put?: never; /** * Reactivate a billing meter - * @description

Reactivates a billing meter

+ * @description

When a meter is reactivated, events for this meter can be accepted and you can attach the meter to a price.

*/ post: operations["PostBillingMetersIdReactivate"]; delete?: never; @@ -8901,7 +8901,10 @@ export interface components { account_annual_revenue: { /** @description A non-negative integer representing the amount in the [smallest currency unit](/currencies#zero-decimal). */ amount?: number | null; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency?: string | null; /** @description The close-out date of the preceding fiscal year in ISO 8601 format. E.g. 2023-12-31 for the 31st of December, 2023. */ fiscal_year_end?: string | null; @@ -9222,7 +9225,7 @@ export interface components { alternatives?: components["schemas"]["account_requirements_alternative"][] | null; /** * Format: unix-time - * @description Date on which `future_requirements` merges with the main `requirements` hash and `future_requirements` becomes empty. After the transition, `currently_due` requirements may immediately become `past_due`, but the account may also be given a grace period depending on the capability's enablement state prior to transitioning. + * @description Date on which `future_requirements` becomes the main `requirements` hash and `future_requirements` becomes empty. After the transition, `currently_due` requirements may immediately become `past_due`, but the account may also be given a grace period depending on the capability's enablement state prior to transitioning. */ current_deadline?: number | null; /** @description Fields that need to be collected to keep the capability enabled. If not collected by `future_requirements[current_deadline]`, these fields will transition to the main `requirements` hash. */ @@ -9234,7 +9237,7 @@ export interface components { disabled_reason?: "other" | "paused.inactivity" | "pending.onboarding" | "pending.review" | "platform_disabled" | "platform_paused" | "rejected.inactivity" | "rejected.other" | "rejected.unsupported_business" | "requirements.fields_needed" | null; /** @description Fields that are `currently_due` and need to be collected again because validation or verification failed. */ errors: components["schemas"]["account_requirements_error"][]; - /** @description Fields that need to be collected assuming all volume thresholds are reached. As they become required, they appear in `currently_due` as well. */ + /** @description Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well. */ eventually_due: string[]; /** @description Fields that weren't collected by `requirements.current_deadline`. These fields need to be collected to enable the capability on the account. New fields will never appear here; `future_requirements.past_due` will always be a subset of `requirements.past_due`. */ past_due: string[]; @@ -9259,7 +9262,7 @@ export interface components { disabled_reason?: "other" | "paused.inactivity" | "pending.onboarding" | "pending.review" | "platform_disabled" | "platform_paused" | "rejected.inactivity" | "rejected.other" | "rejected.unsupported_business" | "requirements.fields_needed" | null; /** @description Fields that are `currently_due` and need to be collected again because validation or verification failed. */ errors: components["schemas"]["account_requirements_error"][]; - /** @description Fields that need to be collected assuming all volume thresholds are reached. As they become required, they appear in `currently_due` as well, and `current_deadline` becomes set. */ + /** @description Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well, and `current_deadline` becomes set. */ eventually_due: string[]; /** @description Fields that weren't collected by `current_deadline`. These fields need to be collected to enable the capability on the account. */ past_due: string[]; @@ -9300,7 +9303,7 @@ export interface components { alternatives?: components["schemas"]["account_requirements_alternative"][] | null; /** * Format: unix-time - * @description Date on which `future_requirements` merges with the main `requirements` hash and `future_requirements` becomes empty. After the transition, `currently_due` requirements may immediately become `past_due`, but the account may also be given a grace period depending on its enablement state prior to transitioning. + * @description Date on which `future_requirements` becomes the main `requirements` hash and `future_requirements` becomes empty. After the transition, `currently_due` requirements may immediately become `past_due`, but the account may also be given a grace period depending on its enablement state prior to transitioning. */ current_deadline?: number | null; /** @description Fields that need to be collected to keep the account enabled. If not collected by `future_requirements[current_deadline]`, these fields will transition to the main `requirements` hash. */ @@ -9312,7 +9315,7 @@ export interface components { disabled_reason?: "action_required.requested_capabilities" | "listed" | "other" | "platform_paused" | "rejected.fraud" | "rejected.incomplete_verification" | "rejected.listed" | "rejected.other" | "rejected.platform_fraud" | "rejected.platform_other" | "rejected.platform_terms_of_service" | "rejected.terms_of_service" | "requirements.past_due" | "requirements.pending_verification" | "under_review" | null; /** @description Fields that are `currently_due` and need to be collected again because validation or verification failed. */ errors?: components["schemas"]["account_requirements_error"][] | null; - /** @description Fields that need to be collected assuming all volume thresholds are reached. As they become required, they appear in `currently_due` as well. */ + /** @description Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well. */ eventually_due?: string[] | null; /** @description Fields that weren't collected by `requirements.current_deadline`. These fields need to be collected to enable the capability on the account. New fields will never appear here; `future_requirements.past_due` will always be a subset of `requirements.past_due`. */ past_due?: string[] | null; @@ -9359,7 +9362,10 @@ export interface components { account_monthly_estimated_revenue: { /** @description A non-negative integer representing how much to charge in the [smallest currency unit](/currencies#zero-decimal). */ amount: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; }; /** AccountPaymentsSettings */ @@ -9401,7 +9407,7 @@ export interface components { disabled_reason?: "action_required.requested_capabilities" | "listed" | "other" | "platform_paused" | "rejected.fraud" | "rejected.incomplete_verification" | "rejected.listed" | "rejected.other" | "rejected.platform_fraud" | "rejected.platform_other" | "rejected.platform_terms_of_service" | "rejected.terms_of_service" | "requirements.past_due" | "requirements.pending_verification" | "under_review" | null; /** @description Fields that are `currently_due` and need to be collected again because validation or verification failed. */ errors?: components["schemas"]["account_requirements_error"][] | null; - /** @description Fields that need to be collected assuming all volume thresholds are reached. As they become required, they appear in `currently_due` as well, and `current_deadline` becomes set. */ + /** @description Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well, and `current_deadline` becomes set. */ eventually_due?: string[] | null; /** @description Fields that weren't collected by `current_deadline`. These fields need to be collected to enable the account. */ past_due?: string[] | null; @@ -9562,6 +9568,15 @@ export interface components { /** @description State, county, province, or region. */ state?: string | null; }; + /** amazon_pay_underlying_payment_method_funding_details */ + amazon_pay_underlying_payment_method_funding_details: { + card?: components["schemas"]["payment_method_details_passthrough_card"]; + /** + * @description funding type of the underlying payment method. + * @enum {string|null} + */ + type?: "card" | null; + }; /** APIErrors */ api_errors: { /** @description For card errors, the ID of the failed charge. */ @@ -9574,6 +9589,10 @@ export interface components { doc_url?: string; /** @description A human-readable message providing more details about the error. For card errors, these messages can be shown to your users. */ message?: string; + /** @description For card errors resulting from a card issuer decline, a 2 digit code which indicates the advice given to merchant by the card network on how to proceed with an error. */ + network_advice_code?: string; + /** @description For card errors resulting from a card issuer decline, a brand specific 2, 3, or 4 digit code which indicates the reason the authorization failed. */ + network_decline_code?: string; /** @description If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field. */ param?: string; payment_intent?: components["schemas"]["payment_intent"]; @@ -9640,7 +9659,10 @@ export interface components { * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ created: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description Polymorphic source of the application fee. Includes the ID of the object the application fee was created from. */ fee_source?: components["schemas"]["platform_earning_fee_source"] | null; @@ -9717,6 +9739,11 @@ export interface components { }; /** AutomaticTax */ automatic_tax: { + /** + * @description If Stripe disabled automatic tax, this enum describes why. + * @enum {string|null} + */ + disabled_reason?: "finalization_requires_location_inputs" | "finalization_system_error" | null; /** @description Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified [tax rates](https://stripe.com/docs/api/tax_rates), negative amounts, or `tax_behavior=unspecified`) cannot be added to automatic tax invoices. */ enabled: boolean; /** @description The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account. */ @@ -9763,7 +9790,10 @@ export interface components { balance_amount: { /** @description Balance amount. */ amount: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; source_types?: components["schemas"]["balance_amount_by_source_type"]; }; @@ -9780,7 +9810,10 @@ export interface components { balance_amount_net: { /** @description Balance amount. */ amount: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description Breakdown of balance by destination. */ net_available?: components["schemas"]["balance_net_available"][]; @@ -9819,7 +9852,10 @@ export interface components { * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ created: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ description?: string | null; @@ -9845,10 +9881,10 @@ export interface components { /** @description The transaction's net funds status in the Stripe balance, which are either `available` or `pending`. */ status: string; /** - * @description Transaction type: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `climate_order_purchase`, `climate_order_refund`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_outbound`, `obligation_reversal_inbound`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`. Learn more about [balance transaction types and what they represent](https://stripe.com/docs/reports/balance-transaction-types). To classify transactions for accounting purposes, consider `reporting_category` instead. + * @description Transaction type: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `climate_order_purchase`, `climate_order_refund`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_outbound`, `obligation_reversal_inbound`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `payout_minimum_balance_hold`, `payout_minimum_balance_release`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`. Learn more about [balance transaction types and what they represent](https://stripe.com/docs/reports/balance-transaction-types). To classify transactions for accounting purposes, consider `reporting_category` instead. * @enum {string} */ - type: "adjustment" | "advance" | "advance_funding" | "anticipation_repayment" | "application_fee" | "application_fee_refund" | "charge" | "climate_order_purchase" | "climate_order_refund" | "connect_collection_transfer" | "contribution" | "issuing_authorization_hold" | "issuing_authorization_release" | "issuing_dispute" | "issuing_transaction" | "obligation_outbound" | "obligation_reversal_inbound" | "payment" | "payment_failure_refund" | "payment_network_reserve_hold" | "payment_network_reserve_release" | "payment_refund" | "payment_reversal" | "payment_unreconciled" | "payout" | "payout_cancel" | "payout_failure" | "refund" | "refund_failure" | "reserve_transaction" | "reserved_funds" | "stripe_fee" | "stripe_fx_fee" | "tax_fee" | "topup" | "topup_reversal" | "transfer" | "transfer_cancel" | "transfer_failure" | "transfer_refund"; + type: "adjustment" | "advance" | "advance_funding" | "anticipation_repayment" | "application_fee" | "application_fee_refund" | "charge" | "climate_order_purchase" | "climate_order_refund" | "connect_collection_transfer" | "contribution" | "issuing_authorization_hold" | "issuing_authorization_release" | "issuing_dispute" | "issuing_transaction" | "obligation_outbound" | "obligation_reversal_inbound" | "payment" | "payment_failure_refund" | "payment_network_reserve_hold" | "payment_network_reserve_release" | "payment_refund" | "payment_reversal" | "payment_unreconciled" | "payout" | "payout_cancel" | "payout_failure" | "payout_minimum_balance_hold" | "payout_minimum_balance_release" | "refund" | "refund_failure" | "reserve_transaction" | "reserved_funds" | "stripe_fee" | "stripe_fx_fee" | "tax_fee" | "topup" | "topup_reversal" | "transfer" | "transfer_cancel" | "transfer_failure" | "transfer_refund"; }; /** * BankAccount @@ -9875,7 +9911,10 @@ export interface components { bank_name?: string | null; /** @description Two-letter ISO code representing the country the bank account is located in. */ country: string; - /** @description Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account. */ + /** + * Format: currency + * @description Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account. + */ currency: string; /** @description The ID of the customer that the bank account is associated with. */ customer?: (string | components["schemas"]["customer"] | components["schemas"]["deleted_customer"]) | null; @@ -10147,7 +10186,7 @@ export interface components { customer: string | components["schemas"]["customer"] | components["schemas"]["deleted_customer"]; /** * Format: unix-time - * @description The time when the billing credits become effective—when they're eligible for use. + * @description The time when the billing credits become effective-when they're eligible for use. */ effective_at?: number | null; /** @@ -10185,7 +10224,7 @@ export interface components { }; /** * BillingMeter - * @description A billing meter is a resource that allows you to track usage of a particular event. For example, you might create a billing meter to track the number of API calls made by a particular user. You can then attach the billing meter to a price and attach the price to a subscription to charge the user for the number of API calls they make. + * @description Meters specify how to aggregate meter events over a billing period. Meter events represent the actions that customers take in your system. Meters attach to prices and form the basis of the bill. * * Related guide: [Usage based billing](https://docs.stripe.com/billing/subscriptions/usage-based) */ @@ -10230,8 +10269,7 @@ export interface components { }; /** * BillingMeterEvent - * @description A billing meter event represents a customer's usage of a product. Meter events are used to bill a customer based on their usage. - * Meter events are associated with billing meters, which define the shape of the event's payload and how those events are aggregated for billing. + * @description Meter events represent actions that customers take in your system. You can use meter events to bill a customer based on their usage. Meter events are associated with billing meters, which define both the contents of the event’s payload and how to aggregate those events. */ "billing.meter_event": { /** @@ -10346,11 +10384,20 @@ export interface components { /** BillingCreditGrantsResourceBalanceCredit */ billing_credit_grants_resource_balance_credit: { amount: components["schemas"]["billing_credit_grants_resource_amount"]; + /** @description Details of the invoice to which the reinstated credits were originally applied. Only present if `type` is `credits_application_invoice_voided`. */ + credits_application_invoice_voided?: components["schemas"]["billing_credit_grants_resource_balance_credits_application_invoice_voided"] | null; /** * @description The type of credit transaction. * @enum {string} */ - type: "credits_granted"; + type: "credits_application_invoice_voided" | "credits_granted"; + }; + /** BillingCreditGrantsResourceBalanceCreditsApplicationInvoiceVoided */ + billing_credit_grants_resource_balance_credits_application_invoice_voided: { + /** @description The invoice to which the reinstated billing credits were originally applied. */ + invoice: string | components["schemas"]["invoice"]; + /** @description The invoice line item to which the reinstated billing credits were originally applied. */ + invoice_line_item: string; }; /** BillingCreditGrantsResourceBalanceCreditsApplied */ billing_credit_grants_resource_balance_credits_applied: { @@ -10380,7 +10427,7 @@ export interface components { /** BillingCreditGrantsResourceScope */ billing_credit_grants_resource_scope: { /** - * @description The price type for which credit grants can apply. We currently only support the `metered` price type. This refers to prices that have a [Billing Meter](https://docs.stripe.com/api/billing/meter) attached to them. + * @description The price type that credit grants can apply to. We currently only support the `metered` price type. This refers to prices that have a [Billing Meter](https://docs.stripe.com/api/billing/meter) attached to them. * @enum {string} */ price_type: "metered"; @@ -10595,13 +10642,21 @@ export interface components { address_zip?: string | null; /** @description If `address_zip` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`. */ address_zip_check?: string | null; + /** + * @description This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to “unspecified”. + * @enum {string|null} + */ + allow_redisplay?: "always" | "limited" | "unspecified" | null; /** @description A set of available payout methods for this card. Only values from this set should be passed as the `method` when creating a payout. */ available_payout_methods?: ("instant" | "standard")[] | null; /** @description Card brand. Can be `American Express`, `Diners Club`, `Discover`, `Eftpos Australia`, `Girocard`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`. */ brand: string; /** @description Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected. */ country?: string | null; - /** @description Three-letter [ISO code for currency](https://www.iso.org/iso-4217-currency-codes.html) in lowercase. Must be a [supported currency](https://docs.stripe.com/currencies). Only applicable on accounts (not customers or recipients). The card can be used as a transfer destination for funds in this currency. This property is only available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. */ + /** + * Format: currency + * @description Three-letter [ISO code for currency](https://www.iso.org/iso-4217-currency-codes.html) in lowercase. Must be a [supported currency](https://docs.stripe.com/currencies). Only applicable on accounts (not customers or recipients). The card can be used as a transfer destination for funds in this currency. This property is only available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. + */ currency?: string | null; /** @description The customer that this card belongs to. This attribute will not be in the card object if the card belongs to an account or recipient instead. */ customer?: (string | components["schemas"]["customer"] | components["schemas"]["deleted_customer"]) | null; @@ -10623,6 +10678,8 @@ export interface components { funding: string; /** @description Unique identifier for the object. */ id: string; + /** @description Issuer identification number of the card. */ + iin?: string; /** @description The last four digits of the card. */ last4: string; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ @@ -10637,6 +10694,11 @@ export interface components { * @enum {string} */ object: "card"; + /** + * @description Status of a card based on the card issuer. + * @enum {string|null} + */ + regulated_status?: "regulated" | "unregulated" | null; /** @description For external accounts that are cards, possible values are `new` and `errored`. If a payout fails, the status is set to `errored` and [scheduled payouts](https://stripe.com/docs/payouts#payout-schedule) are stopped until account details are updated. */ status?: string | null; /** @description If the card number is tokenized, this is the method that was used. Can be `android_pay` (includes Google Pay), `apple_pay`, `masterpass`, `visa_checkout`, or null. */ @@ -10711,7 +10773,10 @@ export interface components { * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ created: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description ID of the customer this charge is for if one exists. */ customer?: (string | components["schemas"]["customer"] | components["schemas"]["deleted_customer"]) | null; @@ -10813,6 +10878,10 @@ export interface components { }; /** ChargeOutcome */ charge_outcome: { + /** @description For charges declined by the network, a 2 digit code which indicates the advice returned by the network on how to proceed with an error. */ + network_advice_code?: string | null; + /** @description For charges declined by the network, a brand specific 2, 3, or 4 digit code which indicates the reason the authorization failed. */ + network_decline_code?: string | null; /** @description Possible values are `approved_by_network`, `declined_by_network`, `not_sent_to_network`, and `reversed_after_approval`. The value `reversed_after_approval` indicates the payment was [blocked by Stripe](https://stripe.com/docs/declines#blocked-payments) after bank authorization, and may temporarily appear as "pending" on a cardholder's statement. */ network_status?: string | null; /** @description An enumerated value providing a more detailed explanation of the outcome's `type`. Charges blocked by Radar's default block rule have the value `highest_risk_level`. Charges placed in review by Radar's default review rule have the value `elevated_risk_level`. Charges authorized, blocked, or placed in review by custom rules have the value `rule`. See [understanding declines](https://stripe.com/docs/declines) for more details. */ @@ -10886,7 +10955,10 @@ export interface components { * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ created: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency?: string | null; /** @description Currency conversion details for [Adaptive Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing) sessions */ currency_conversion?: components["schemas"]["payment_pages_checkout_session_currency_conversion"] | null; @@ -11516,9 +11588,15 @@ export interface components { capture_method?: "manual"; }; /** checkout_payment_method_options_mandate_options_bacs_debit */ - checkout_payment_method_options_mandate_options_bacs_debit: Record; + checkout_payment_method_options_mandate_options_bacs_debit: { + /** @description Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'. */ + reference_prefix?: string; + }; /** checkout_payment_method_options_mandate_options_sepa_debit */ - checkout_payment_method_options_mandate_options_sepa_debit: Record; + checkout_payment_method_options_mandate_options_sepa_debit: { + /** @description Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'. */ + reference_prefix?: string; + }; /** CheckoutPaynowPaymentMethodOptions */ checkout_paynow_payment_method_options: { /** @@ -12051,7 +12129,10 @@ export interface components { connect_collection_transfer: { /** @description Amount transferred, in cents (or local equivalent). */ amount: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description ID of the account that funds are being collected for. */ destination: string | components["schemas"]["account"]; @@ -12073,7 +12154,7 @@ export interface components { }; /** ConnectEmbeddedAccountFeaturesClaim */ connect_embedded_account_features_claim: { - /** @description Disables Stripe user authentication for this embedded component. This feature can only be false for accounts where you’re responsible for collecting updated information when requirements are due or change, like custom accounts. The default value for this feature is `false` when `external_account_collection` is enabled and `true` otherwise. */ + /** @description Disables Stripe user authentication for this embedded component. This value can only be true for accounts where `controller.requirement_collection` is `application`. The default value is the opposite of the `external_account_collection` value. For example, if you don’t set `external_account_collection`, it defaults to true and `disable_stripe_user_authentication` defaults to false. */ disable_stripe_user_authentication: boolean; /** @description Whether to allow platforms to control bank account collection for their connected accounts. This feature can only be false for accounts where you’re responsible for collecting updated information when requirements are due or change, like custom accounts. Otherwise, bank account collection is determined by compliance requirements. The default value for this feature is `true`. */ external_account_collection: boolean; @@ -12125,7 +12206,7 @@ export interface components { }; /** ConnectEmbeddedPayoutsFeatures */ connect_embedded_payouts_features: { - /** @description Disables Stripe user authentication for this embedded component. This feature can only be false for accounts where you’re responsible for collecting updated information when requirements are due or change, like custom accounts. The default value for this feature is `false` when `external_account_collection` is enabled and `true` otherwise. */ + /** @description Disables Stripe user authentication for this embedded component. This value can only be true for accounts where `controller.requirement_collection` is `application`. The default value is the opposite of the `external_account_collection` value. For example, if you don’t set `external_account_collection`, it defaults to true and `disable_stripe_user_authentication` defaults to false. */ disable_stripe_user_authentication: boolean; /** @description Whether to allow payout schedule to be changed. Default `true` when Stripe owns Loss Liability, default `false` otherwise. */ edit_payout_schedule: boolean; @@ -12194,7 +12275,10 @@ export interface components { * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ created: number; - /** @description If `amount_off` has been set, the three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the amount to take off. */ + /** + * Format: currency + * @description If `amount_off` has been set, the three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the amount to take off. + */ currency?: string | null; /** @description Coupons defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies). */ currency_options?: { @@ -12267,7 +12351,10 @@ export interface components { * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ created: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description ID of the customer. */ customer: string | components["schemas"]["customer"] | components["schemas"]["deleted_customer"]; @@ -12720,7 +12807,10 @@ export interface components { created: number; /** @description The ID of the credit note (if any) related to the transaction. */ credit_note?: (string | components["schemas"]["credit_note"]) | null; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description The ID of the customer the transaction belongs to. */ customer: string | components["schemas"]["customer"]; @@ -13392,7 +13482,10 @@ export interface components { * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ created: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description List of eligibility types that are included in `enhanced_evidence`. */ enhanced_eligibility_types: "visa_compelling_evidence_3"[]; @@ -13427,6 +13520,7 @@ export interface components { /** DisputeEnhancedEligibility */ dispute_enhanced_eligibility: { visa_compelling_evidence_3?: components["schemas"]["dispute_enhanced_eligibility_visa_compelling_evidence3"]; + visa_compliance?: components["schemas"]["dispute_enhanced_eligibility_visa_compliance"]; }; /** DisputeEnhancedEligibilityVisaCompellingEvidence3 */ dispute_enhanced_eligibility_visa_compelling_evidence3: { @@ -13438,9 +13532,18 @@ export interface components { */ status: "not_qualified" | "qualified" | "requires_action"; }; + /** DisputeEnhancedEligibilityVisaCompliance */ + dispute_enhanced_eligibility_visa_compliance: { + /** + * @description Visa compliance eligibility status. + * @enum {string} + */ + status: "fee_acknowledged" | "requires_fee_acknowledgement"; + }; /** DisputeEnhancedEvidence */ dispute_enhanced_evidence: { visa_compelling_evidence_3?: components["schemas"]["dispute_enhanced_evidence_visa_compelling_evidence3"]; + visa_compliance?: components["schemas"]["dispute_enhanced_evidence_visa_compliance"]; }; /** DisputeEnhancedEvidenceVisaCompellingEvidence3 */ dispute_enhanced_evidence_visa_compelling_evidence3: { @@ -13449,6 +13552,11 @@ export interface components { /** @description List of exactly two prior undisputed transaction objects for Visa Compelling Evidence 3.0 evidence submission. */ prior_undisputed_transactions: components["schemas"]["dispute_visa_compelling_evidence3_prior_undisputed_transaction"][]; }; + /** DisputeEnhancedEvidenceVisaCompliance */ + dispute_enhanced_evidence_visa_compliance: { + /** @description A field acknowledging the fee incurred when countering a Visa compliance dispute. If this field is set to true, evidence can be submitted for the compliance dispute. Stripe collects a 500 USD (or local equivalent) amount to cover the network costs associated with resolving compliance disputes. Stripe refunds the 500 USD network fee if you win the dispute. */ + fee_acknowledged: boolean; + }; /** DisputeEvidence */ dispute_evidence: { /** @description Any server or activity logs showing proof that the customer accessed or downloaded the purchased digital product. This information should include IP addresses, corresponding timestamps, and any detailed recorded activity. */ @@ -13826,7 +13934,10 @@ export interface components { amount: number; /** @description ID of the Connect application that earned the fee. */ application?: string | null; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ description?: string | null; @@ -13851,7 +13962,10 @@ export interface components { * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ created: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description ID of the application fee that was refunded. */ fee: string | components["schemas"]["application_fee"]; @@ -14190,7 +14304,10 @@ export interface components { columns?: string[]; /** @description Connected account ID by which to filter the report run. */ connected_account?: string; - /** @description Currency of objects to be included in the report run. */ + /** + * Format: currency + * @description Currency of objects to be included in the report run. + */ currency?: string; /** * Format: unix-time @@ -14297,7 +14414,7 @@ export interface components { /** @description The PaymentMethod to insert into the forwarded request. Forwarding previously consumed PaymentMethods is allowed. */ payment_method: string; /** @description The field kinds to be replaced in the forwarded request. */ - replacements: ("card_cvc" | "card_expiry" | "card_number" | "cardholder_name")[]; + replacements: ("card_cvc" | "card_expiry" | "card_number" | "cardholder_name" | "request_signature")[]; /** @description Context about the request from Stripe's servers to the destination endpoint. */ request_context?: components["schemas"]["forwarded_request_context"] | null; /** @description The request that was sent to the destination endpoint. We redact any sensitive fields. */ @@ -14386,8 +14503,10 @@ export interface components { * @description Iban Records contain E.U. bank account details per the SEPA format. */ funding_instructions_bank_transfer_iban_record: { + account_holder_address: components["schemas"]["address"]; /** @description The name of the person or business that owns the bank account */ account_holder_name: string; + bank_address: components["schemas"]["address"]; /** @description The BIC/SWIFT code of the account. */ bic: string; /** @description Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). */ @@ -14400,10 +14519,12 @@ export interface components { * @description Sort Code Records contain U.K. bank account details per the sort code format. */ funding_instructions_bank_transfer_sort_code_record: { + account_holder_address: components["schemas"]["address"]; /** @description The name of the person or business that owns the bank account */ account_holder_name: string; /** @description The account number */ account_number: string; + bank_address: components["schemas"]["address"]; /** @description The six-digit sort code */ sort_code: string; }; @@ -14412,6 +14533,10 @@ export interface components { * @description SPEI Records contain Mexico bank account details per the SPEI format. */ funding_instructions_bank_transfer_spei_record: { + account_holder_address: components["schemas"]["address"]; + /** @description The account holder name */ + account_holder_name: string; + bank_address: components["schemas"]["address"]; /** @description The three-digit bank code */ bank_code: string; /** @description The short banking institution name */ @@ -14442,12 +14567,14 @@ export interface components { * @description Zengin Records contain Japan bank account details per the Zengin format. */ funding_instructions_bank_transfer_zengin_record: { + account_holder_address: components["schemas"]["address"]; /** @description The account holder name */ account_holder_name?: string | null; /** @description The account number */ account_number?: string | null; /** @description The bank account type. In Japan, this can only be `futsu` or `toza`. */ account_type?: string | null; + bank_address: components["schemas"]["address"]; /** @description The bank code of the account */ bank_code?: string | null; /** @description The bank name of the account */ @@ -15021,7 +15148,10 @@ export interface components { * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ created: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description Custom fields displayed on the invoice. */ custom_fields?: components["schemas"]["invoice_setting_custom_field"][] | null; @@ -15456,7 +15586,10 @@ export interface components { invoiceitem: { /** @description Amount (in the `currency` specified) of the invoice item. This should always be equal to `unit_amount * quantity`. */ amount: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description The ID of the customer who will be billed when this invoice item is billed. */ customer: string | components["schemas"]["customer"] | components["schemas"]["deleted_customer"]; @@ -15556,10 +15689,10 @@ export interface components { /** InvoicesResourceInvoiceTaxID */ invoices_resource_invoice_tax_id: { /** - * @description The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, or `unknown` + * @description The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, or `unknown` * @enum {string} */ - type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "by_tin" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "li_vat" | "ma_vat" | "md_vat" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "tz_vat" | "ua_vat" | "unknown" | "us_ein" | "uy_ruc" | "uz_tin" | "uz_vat" | "ve_rif" | "vn_tin" | "za_vat"; + type: "ad_nrt" | "ae_trn" | "al_tin" | "am_tin" | "ao_tin" | "ar_cuit" | "au_abn" | "au_arn" | "ba_tin" | "bb_tin" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "bs_tin" | "by_tin" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "cd_nif" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "gn_nif" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kh_tin" | "kr_brn" | "kz_bin" | "li_uid" | "li_vat" | "ma_vat" | "md_vat" | "me_pib" | "mk_vat" | "mr_nif" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "np_pan" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sn_ninea" | "sr_fin" | "sv_nit" | "th_vat" | "tj_tin" | "tr_tin" | "tw_vat" | "tz_vat" | "ua_vat" | "ug_tin" | "unknown" | "us_ein" | "uy_ruc" | "uz_tin" | "uz_vat" | "ve_rif" | "vn_tin" | "za_vat" | "zm_tin" | "zw_tin"; /** @description The value of the tax ID. */ value?: string | null; }; @@ -15655,7 +15788,10 @@ export interface components { * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ created: number; - /** @description The currency of the cardholder. This currency can be different from the currency presented at authorization and the `merchant_currency` field on this authorization. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description The currency of the cardholder. This currency can be different from the currency presented at authorization and the `merchant_currency` field on this authorization. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description Fleet-specific information for authorizations using Fleet cards. */ fleet?: components["schemas"]["issuing_authorization_fleet_data"] | null; @@ -15669,7 +15805,10 @@ export interface components { livemode: boolean; /** @description The total amount that was authorized or rejected. This amount is in the `merchant_currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). `merchant_amount` should be the same as `amount`, unless `merchant_currency` and `currency` are different. */ merchant_amount: number; - /** @description The local currency that was presented to the cardholder for the authorization. This currency can be different from the cardholder currency and the `currency` field on this authorization. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description The local currency that was presented to the cardholder for the authorization. This currency can be different from the cardholder currency and the `currency` field on this authorization. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ merchant_currency: string; merchant_data: components["schemas"]["issuing_authorization_merchant_data"]; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ @@ -15722,7 +15861,10 @@ export interface components { * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ created: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Supported currencies are `usd` in the US, `eur` in the EU, and `gbp` in the UK. */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Supported currencies are `usd` in the US, `eur` in the EU, and `gbp` in the UK. + */ currency: string; /** @description The card's CVC. For security reasons, this is only available for virtual cards, and will be omitted unless you explicitly request it with [the `expand` parameter](https://stripe.com/docs/api/expanding_objects). Additionally, it's only available via the ["Retrieve a card" endpoint](https://stripe.com/docs/api/issuing/cards/retrieve), not via "List all cards" or any other endpoint. */ cvc?: string; @@ -15845,7 +15987,10 @@ export interface components { * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ created: number; - /** @description The currency the `transaction` was made in. */ + /** + * Format: currency + * @description The currency the `transaction` was made in. + */ currency: string; evidence: components["schemas"]["issuing_dispute_evidence"]; /** @description Unique identifier for the object. */ @@ -15962,7 +16107,10 @@ export interface components { * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ created: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description Unique identifier for the object. */ id: string; @@ -16075,7 +16223,10 @@ export interface components { * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ created: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description If you've disputed the transaction, the ID of the dispute. */ dispute?: (string | components["schemas"]["issuing.dispute"]) | null; @@ -16085,7 +16236,10 @@ export interface components { livemode: boolean; /** @description The amount that the merchant will receive, denominated in `merchant_currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). It will be different from `amount` if the merchant is taking payment in a different currency. */ merchant_amount: number; - /** @description The currency with which the merchant is taking payment. */ + /** + * Format: currency + * @description The currency with which the merchant is taking payment. + */ merchant_currency: string; merchant_data: components["schemas"]["issuing_authorization_merchant_data"]; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ @@ -16267,6 +16421,8 @@ export interface components { postal_code?: string | null; /** @description State where the seller is located */ state?: string | null; + /** @description The seller's tax identification number. Currently populated for French merchants only. */ + tax_id?: string | null; /** @description An ID assigned by the seller to the location of the sale. */ terminal_id?: string | null; /** @description URL provided by the merchant on a 3DS request */ @@ -16287,13 +16443,19 @@ export interface components { amount: number; /** @description Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ amount_details?: components["schemas"]["issuing_authorization_amount_details"] | null; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description If set `true`, you may provide [amount](https://stripe.com/docs/api/issuing/authorizations/approve#approve_issuing_authorization-amount) to control how much to hold for the authorization. */ is_amount_controllable: boolean; /** @description The amount the merchant is requesting to be authorized in the `merchant_currency`. The amount is in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ merchant_amount: number; - /** @description The local currency the merchant is requesting to authorize. */ + /** + * Format: currency + * @description The local currency the merchant is requesting to authorize. + */ merchant_currency: string; /** @description The card network's estimate of the likelihood that an authorization is fraudulent. Takes on values between 1 and 99. */ network_risk_score?: number | null; @@ -16402,7 +16564,10 @@ export interface components { blocked_merchant_countries?: string[] | null; /** @description Limit spending with amount-based rules that apply across any cards this card replaced (i.e., its `replacement_for` card and _that_ card's `replacement_for` card, up the chain). */ spending_limits?: components["schemas"]["issuing_card_spending_limit"][] | null; - /** @description Currency of the amounts within `spending_limits`. Always the same as the currency of the card. */ + /** + * Format: currency + * @description Currency of the amounts within `spending_limits`. Always the same as the currency of the card. + */ spending_limits_currency?: string | null; }; /** IssuingCardGooglePay */ @@ -16513,7 +16678,10 @@ export interface components { blocked_merchant_countries?: string[] | null; /** @description Limit spending with amount-based rules that apply across this cardholder's cards. */ spending_limits?: components["schemas"]["issuing_cardholder_spending_limit"][] | null; - /** @description Currency of the amounts within `spending_limits`. */ + /** + * Format: currency + * @description Currency of the amounts within `spending_limits`. + */ spending_limits_currency?: string | null; }; /** IssuingCardholderCardIssuing */ @@ -17068,10 +17236,13 @@ export interface components { amount_tax: number; /** @description Total after discounts and taxes. */ amount_total: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description An arbitrary string attached to the object. Often useful for displaying to users. Defaults to product name. */ - description?: string; + description?: string | null; /** @description The discounts applied to the line item. */ discounts?: components["schemas"]["line_items_discount_amount"][]; /** @description Unique identifier for the object. */ @@ -17226,7 +17397,10 @@ export interface components { amount: number; /** @description The integer amount in cents (or local equivalent) representing the amount for this line item, excluding all tax and discounts. */ amount_excluding_tax?: number | null; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ description?: string | null; @@ -17452,7 +17626,10 @@ export interface components { mandate_single_use: { /** @description The amount of the payment on a single use mandate. */ amount: number; - /** @description The currency of the payment on a single use mandate. */ + /** + * Format: currency + * @description The currency of the payment on a single use mandate. + */ currency: string; }; /** mandate_us_bank_account */ @@ -17802,7 +17979,10 @@ export interface components { * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ created: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description ID of the Customer this PaymentIntent belongs to, if one exists. * @@ -17965,7 +18145,10 @@ export interface components { payment_intent_next_action_display_bank_transfer_instructions: { /** @description The remaining amount that needs to be transferred to complete the payment. */ amount_remaining?: number | null; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency?: string | null; /** @description A list of financial addresses that can be used to fund the customer balance */ financial_addresses?: components["schemas"]["funding_instructions_bank_transfer_financial_address"][]; @@ -18385,9 +18568,15 @@ export interface components { transaction_type?: "business" | "personal" | null; }; /** payment_intent_payment_method_options_mandate_options_bacs_debit */ - payment_intent_payment_method_options_mandate_options_bacs_debit: Record; + payment_intent_payment_method_options_mandate_options_bacs_debit: { + /** @description Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'. */ + reference_prefix?: string; + }; /** payment_intent_payment_method_options_mandate_options_sepa_debit */ - payment_intent_payment_method_options_mandate_options_sepa_debit: Record; + payment_intent_payment_method_options_mandate_options_sepa_debit: { + /** @description Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'. */ + reference_prefix?: string; + }; /** payment_intent_payment_method_options_mobilepay */ payment_intent_payment_method_options_mobilepay: { /** @@ -18424,7 +18613,7 @@ export interface components { }; /** payment_intent_payment_method_options_swish */ payment_intent_payment_method_options_swish: { - /** @description The order ID displayed in the Swish app after the payment is authorized. */ + /** @description A reference for this payment to be displayed in the Swish app. */ reference?: string | null; /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -18541,7 +18730,10 @@ export interface components { billing_address_collection: "auto" | "required"; /** @description When set, provides configuration to gather active consent from customers. */ consent_collection?: components["schemas"]["payment_links_resource_consent_collection"] | null; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description Collect additional information from your customer using custom fields. Up to 3 fields are supported. */ custom_fields: components["schemas"]["payment_links_resource_custom_fields"][]; @@ -19008,6 +19200,11 @@ export interface components { last4: string; /** @description Contains information about card networks that can be used to process the payment. */ networks?: components["schemas"]["networks"] | null; + /** + * @description Status of a card based on the card issuer. + * @enum {string|null} + */ + regulated_status?: "regulated" | "unregulated" | null; /** @description Contains details on how this Card may be used for 3D Secure authentication. */ three_d_secure_usage?: components["schemas"]["three_d_secure_usage"] | null; /** @description If this Card is part of a card wallet, this contains the details of the card wallet. */ @@ -19357,7 +19554,9 @@ export interface components { /** payment_method_details_alma */ payment_method_details_alma: Record; /** payment_method_details_amazon_pay */ - payment_method_details_amazon_pay: Record; + payment_method_details_amazon_pay: { + funding?: components["schemas"]["amazon_pay_underlying_payment_method_funding_details"]; + }; /** payment_method_details_au_becs_debit */ payment_method_details_au_becs_debit: { /** @description Bank-State-Branch number of the bank account. */ @@ -19456,7 +19655,14 @@ export interface components { network?: string | null; /** @description If this card has network token credentials, this contains the details of the network token credentials. */ network_token?: components["schemas"]["payment_method_details_card_network_token"] | null; + /** @description This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. The first three digits of the Trace ID is the Financial Network Code, the next 6 digits is the Banknet Reference Number, and the last 4 digits represent the date (MM/DD). This field will be available for successful Visa, Mastercard, or American Express transactions and always null for other card brands. */ + network_transaction_id?: string | null; overcapture?: components["schemas"]["payment_flows_private_payment_methods_card_details_api_resource_enterprise_features_overcapture_overcapture"]; + /** + * @description Status of a card based on the card issuer. + * @enum {string|null} + */ + regulated_status?: "regulated" | "unregulated" | null; /** @description Populated if this transaction used 3D Secure authentication. */ three_d_secure?: components["schemas"]["three_d_secure_details_charge"] | null; /** @description If this Card is part of a card wallet, this contains the details of the card wallet. */ @@ -19861,6 +20067,21 @@ export interface components { * Przelewy24 rarely provides this information so the attribute is usually empty. */ verified_name?: string | null; }; + /** payment_method_details_passthrough_card */ + payment_method_details_passthrough_card: { + /** @description Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ + brand?: string | null; + /** @description Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected. */ + country?: string | null; + /** @description Two-digit number representing the card's expiration month. */ + exp_month?: number | null; + /** @description Four-digit number representing the card's expiration year. */ + exp_year?: number | null; + /** @description Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. */ + funding?: string | null; + /** @description The last four digits of the card. */ + last4?: string | null; + }; /** payment_method_details_payco */ payment_method_details_payco: { /** @description A unique identifier for the buyer as determined by the local payment processor. */ @@ -19897,7 +20118,9 @@ export interface components { reference?: string | null; }; /** payment_method_details_revolut_pay */ - payment_method_details_revolut_pay: Record; + payment_method_details_revolut_pay: { + funding?: components["schemas"]["revolut_pay_underlying_payment_method_funding_details"]; + }; /** payment_method_details_samsung_pay */ payment_method_details_samsung_pay: { /** @description A unique identifier for the buyer as determined by the local payment processor. */ @@ -21084,10 +21307,10 @@ export interface components { /** PaymentPagesCheckoutSessionTaxID */ payment_pages_checkout_session_tax_id: { /** - * @description The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, or `unknown` + * @description The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, or `unknown` * @enum {string} */ - type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "by_tin" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "li_vat" | "ma_vat" | "md_vat" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "tz_vat" | "ua_vat" | "unknown" | "us_ein" | "uy_ruc" | "uz_tin" | "uz_vat" | "ve_rif" | "vn_tin" | "za_vat"; + type: "ad_nrt" | "ae_trn" | "al_tin" | "am_tin" | "ao_tin" | "ar_cuit" | "au_abn" | "au_arn" | "ba_tin" | "bb_tin" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "bs_tin" | "by_tin" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "cd_nif" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "gn_nif" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kh_tin" | "kr_brn" | "kz_bin" | "li_uid" | "li_vat" | "ma_vat" | "md_vat" | "me_pib" | "mk_vat" | "mr_nif" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "np_pan" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sn_ninea" | "sr_fin" | "sv_nit" | "th_vat" | "tj_tin" | "tr_tin" | "tw_vat" | "tz_vat" | "ua_vat" | "ug_tin" | "unknown" | "us_ein" | "uy_ruc" | "uz_tin" | "uz_vat" | "ve_rif" | "vn_tin" | "za_vat" | "zm_tin" | "zw_tin"; /** @description The value of the tax ID. */ value?: string | null; }; @@ -21152,7 +21375,10 @@ export interface components { * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ created: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ description?: string | null; @@ -21330,7 +21556,7 @@ export interface components { currently_due: string[]; /** @description Fields that are `currently_due` and need to be collected again because validation or verification failed. */ errors: components["schemas"]["account_requirements_error"][]; - /** @description Fields that need to be collected assuming all volume thresholds are reached. As they become required, they appear in `currently_due` as well, and the account's `future_requirements[current_deadline]` becomes set. */ + /** @description Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well, and the account's `future_requirements[current_deadline]` becomes set. */ eventually_due: string[]; /** @description Fields that weren't collected by the account's `requirements.current_deadline`. These fields need to be collected to enable the person's account. New fields will never appear here; `future_requirements.past_due` will always be a subset of `requirements.past_due`. */ past_due: string[]; @@ -21339,6 +21565,8 @@ export interface components { }; /** PersonRelationship */ person_relationship: { + /** @description Whether the person is the authorizer of the account's representative. */ + authorizer?: boolean | null; /** @description Whether the person is a director of the account's legal entity. Directors are typically members of the governing board of the company, or responsible for ensuring the company meets its regulatory obligations. */ director?: boolean | null; /** @description Whether the person has significant responsibility to control, manage, or direct the organization. */ @@ -21362,7 +21590,7 @@ export interface components { currently_due: string[]; /** @description Fields that are `currently_due` and need to be collected again because validation or verification failed. */ errors: components["schemas"]["account_requirements_error"][]; - /** @description Fields that need to be collected assuming all volume thresholds are reached. As they become required, they appear in `currently_due` as well, and the account's `current_deadline` becomes set. */ + /** @description Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well, and the account's `current_deadline` becomes set. */ eventually_due: string[]; /** @description Fields that weren't collected by the account's `current_deadline`. These fields need to be collected to enable the person's account. */ past_due: string[]; @@ -21405,7 +21633,10 @@ export interface components { * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ created: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description Unique identifier for the object. */ id: string; @@ -21662,7 +21893,7 @@ export interface components { * @enum {string} */ proration_behavior: "always_invoice" | "create_prorations" | "none"; - schedule_at_period_end?: components["schemas"]["portal_resource_schedule_update_at_period_end"]; + schedule_at_period_end: components["schemas"]["portal_resource_schedule_update_at_period_end"]; }; /** PortalSubscriptionUpdateProduct */ portal_subscription_update_product: { @@ -21693,7 +21924,10 @@ export interface components { * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ created: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description Prices defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies). */ currency_options?: { @@ -22335,7 +22569,10 @@ export interface components { * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ created: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description An arbitrary string attached to the object. You can use this for displaying to users (available on non-card refunds only). */ description?: string; @@ -22612,7 +22849,10 @@ export interface components { /** ReserveTransaction */ reserve_transaction: { amount: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ description?: string | null; @@ -22673,6 +22913,15 @@ export interface components { /** @description Information related to the browsing session of the user who initiated the payment. */ session?: components["schemas"]["radar_review_resource_session"] | null; }; + /** revolut_pay_underlying_payment_method_funding_details */ + revolut_pay_underlying_payment_method_funding_details: { + card?: components["schemas"]["payment_method_details_passthrough_card"]; + /** + * @description funding type of the underlying payment method. + * @enum {string|null} + */ + type?: "card" | null; + }; /** RadarRule */ rule: { /** @description The action taken on the payment. */ @@ -22726,6 +22975,11 @@ export interface components { }; /** SchedulesPhaseAutomaticTax */ schedules_phase_automatic_tax: { + /** + * @description If Stripe disabled automatic tax, this enum describes why. + * @enum {string|null} + */ + disabled_reason?: "requires_location_inputs" | null; /** @description Whether Stripe automatically computes tax on invoices created during this phase. */ enabled: boolean; /** @description The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account. */ @@ -23159,7 +23413,10 @@ export interface components { * @enum {string} */ amount_type: "fixed" | "maximum"; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description A description of the mandate or subscription that is meant to be displayed to the customer. */ description?: string | null; @@ -23209,9 +23466,15 @@ export interface components { transaction_type?: "business" | "personal" | null; }; /** setup_intent_payment_method_options_mandate_options_bacs_debit */ - setup_intent_payment_method_options_mandate_options_bacs_debit: Record; + setup_intent_payment_method_options_mandate_options_bacs_debit: { + /** @description Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'. */ + reference_prefix?: string; + }; /** setup_intent_payment_method_options_mandate_options_sepa_debit */ - setup_intent_payment_method_options_mandate_options_sepa_debit: Record; + setup_intent_payment_method_options_mandate_options_sepa_debit: { + /** @description Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'. */ + reference_prefix?: string; + }; /** setup_intent_payment_method_options_paypal */ setup_intent_payment_method_options_paypal: { /** @description The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer. */ @@ -23326,7 +23589,10 @@ export interface components { shipping_rate_fixed_amount: { /** @description A non-negative integer in cents representing how much to charge. */ amount: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description Shipping rates defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies). */ currency_options?: { @@ -23356,6 +23622,11 @@ export interface components { ach_debit?: components["schemas"]["source_type_ach_debit"]; acss_debit?: components["schemas"]["source_type_acss_debit"]; alipay?: components["schemas"]["source_type_alipay"]; + /** + * @description This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to “unspecified”. + * @enum {string|null} + */ + allow_redisplay?: "always" | "limited" | "unspecified" | null; /** @description A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for `single_use` sources. */ amount?: number | null; au_becs_debit?: components["schemas"]["source_type_au_becs_debit"]; @@ -23370,7 +23641,10 @@ export interface components { * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ created: number; - /** @description Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) associated with the source. This is the currency for which the source will be chargeable once ready. Required for `single_use` sources. */ + /** + * Format: currency + * @description Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) associated with the source. This is the currency for which the source will be chargeable once ready. Required for `single_use` sources. + */ currency?: string | null; /** @description The ID of the customer to which this source is attached. This will not be present when the source has not been attached to a customer. */ customer?: string; @@ -23480,7 +23754,10 @@ export interface components { source_order: { /** @description A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount for the order. */ amount: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description The email address of the customer placing the order. */ email?: string; @@ -23565,7 +23842,10 @@ export interface components { * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ created: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; gbp_credit_transfer?: components["schemas"]["source_transaction_gbp_credit_transfer_data"]; /** @description Unique identifier for the object. */ @@ -23881,7 +24161,10 @@ export interface components { * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ created: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** * Format: unix-time @@ -24005,6 +24288,11 @@ export interface components { }; /** SubscriptionAutomaticTax */ subscription_automatic_tax: { + /** + * @description If Stripe disabled automatic tax, this enum describes why. + * @enum {string|null} + */ + disabled_reason?: "requires_location_inputs" | null; /** @description Whether Stripe automatically computes tax on this subscription. */ enabled: boolean; /** @description The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account. */ @@ -24222,7 +24510,10 @@ export interface components { collection_method?: "charge_automatically" | "send_invoice" | null; /** @description ID of the coupon to use during this phase of the subscription schedule. */ coupon?: (string | components["schemas"]["coupon"] | components["schemas"]["deleted_coupon"]) | null; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings. */ default_payment_method?: (string | components["schemas"]["payment_method"]) | null; @@ -24294,6 +24585,11 @@ export interface components { }; /** SubscriptionSchedulesResourceDefaultSettingsAutomaticTax */ subscription_schedules_resource_default_settings_automatic_tax: { + /** + * @description If Stripe disabled automatic tax, this enum describes why. + * @enum {string|null} + */ + disabled_reason?: "requires_location_inputs" | null; /** @description Whether Stripe automatically computes tax on invoices created during this phase. */ enabled: boolean; /** @description The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account. */ @@ -24766,10 +25062,10 @@ export interface components { /** @description The account or customer the tax ID belongs to. */ owner?: components["schemas"]["tax_i_ds_owner"] | null; /** - * @description Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, or `za_vat`. Note that some legacy tax IDs have type `unknown` + * @description Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `ba_tin`, `bb_tin`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kh_tin`, `kr_brn`, `kz_bin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin`. Note that some legacy tax IDs have type `unknown` * @enum {string} */ - type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "by_tin" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "li_vat" | "ma_vat" | "md_vat" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "tz_vat" | "ua_vat" | "unknown" | "us_ein" | "uy_ruc" | "uz_tin" | "uz_vat" | "ve_rif" | "vn_tin" | "za_vat"; + type: "ad_nrt" | "ae_trn" | "al_tin" | "am_tin" | "ao_tin" | "ar_cuit" | "au_abn" | "au_arn" | "ba_tin" | "bb_tin" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "bs_tin" | "by_tin" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "cd_nif" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "gn_nif" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kh_tin" | "kr_brn" | "kz_bin" | "li_uid" | "li_vat" | "ma_vat" | "md_vat" | "me_pib" | "mk_vat" | "mr_nif" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "np_pan" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sn_ninea" | "sr_fin" | "sv_nit" | "th_vat" | "tj_tin" | "tr_tin" | "tw_vat" | "tz_vat" | "ua_vat" | "ug_tin" | "unknown" | "us_ein" | "uy_ruc" | "uz_tin" | "uz_vat" | "ve_rif" | "vn_tin" | "za_vat" | "zm_tin" | "zw_tin"; /** @description Value of the tax ID. */ value: string; /** @description Tax ID verification information. */ @@ -24790,13 +25086,20 @@ export interface components { /** TaxProductRegistrationsResourceCountryOptions */ tax_product_registrations_resource_country_options: { ae?: components["schemas"]["tax_product_registrations_resource_country_options_default"]; + al?: components["schemas"]["tax_product_registrations_resource_country_options_default"]; + am?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; + ao?: components["schemas"]["tax_product_registrations_resource_country_options_default"]; at?: components["schemas"]["tax_product_registrations_resource_country_options_europe"]; au?: components["schemas"]["tax_product_registrations_resource_country_options_default"]; + ba?: components["schemas"]["tax_product_registrations_resource_country_options_default"]; + bb?: components["schemas"]["tax_product_registrations_resource_country_options_default"]; be?: components["schemas"]["tax_product_registrations_resource_country_options_europe"]; bg?: components["schemas"]["tax_product_registrations_resource_country_options_europe"]; bh?: components["schemas"]["tax_product_registrations_resource_country_options_default"]; + bs?: components["schemas"]["tax_product_registrations_resource_country_options_default"]; by?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; ca?: components["schemas"]["tax_product_registrations_resource_country_options_canada"]; + cd?: components["schemas"]["tax_product_registrations_resource_country_options_default"]; ch?: components["schemas"]["tax_product_registrations_resource_country_options_default"]; cl?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; co?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; @@ -24813,6 +25116,7 @@ export interface components { fr?: components["schemas"]["tax_product_registrations_resource_country_options_europe"]; gb?: components["schemas"]["tax_product_registrations_resource_country_options_default"]; ge?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; + gn?: components["schemas"]["tax_product_registrations_resource_country_options_default"]; gr?: components["schemas"]["tax_product_registrations_resource_country_options_europe"]; hr?: components["schemas"]["tax_product_registrations_resource_country_options_europe"]; hu?: components["schemas"]["tax_product_registrations_resource_country_options_europe"]; @@ -24822,6 +25126,7 @@ export interface components { it?: components["schemas"]["tax_product_registrations_resource_country_options_europe"]; jp?: components["schemas"]["tax_product_registrations_resource_country_options_default"]; ke?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; + kh?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; kr?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; kz?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; lt?: components["schemas"]["tax_product_registrations_resource_country_options_europe"]; @@ -24829,14 +25134,19 @@ export interface components { lv?: components["schemas"]["tax_product_registrations_resource_country_options_europe"]; ma?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; md?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; + me?: components["schemas"]["tax_product_registrations_resource_country_options_default"]; + mk?: components["schemas"]["tax_product_registrations_resource_country_options_default"]; + mr?: components["schemas"]["tax_product_registrations_resource_country_options_default"]; mt?: components["schemas"]["tax_product_registrations_resource_country_options_europe"]; mx?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; my?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; ng?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; nl?: components["schemas"]["tax_product_registrations_resource_country_options_europe"]; no?: components["schemas"]["tax_product_registrations_resource_country_options_default"]; + np?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; nz?: components["schemas"]["tax_product_registrations_resource_country_options_default"]; om?: components["schemas"]["tax_product_registrations_resource_country_options_default"]; + pe?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; pl?: components["schemas"]["tax_product_registrations_resource_country_options_europe"]; pt?: components["schemas"]["tax_product_registrations_resource_country_options_europe"]; ro?: components["schemas"]["tax_product_registrations_resource_country_options_europe"]; @@ -24847,13 +25157,20 @@ export interface components { sg?: components["schemas"]["tax_product_registrations_resource_country_options_default"]; si?: components["schemas"]["tax_product_registrations_resource_country_options_europe"]; sk?: components["schemas"]["tax_product_registrations_resource_country_options_europe"]; + sn?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; + sr?: components["schemas"]["tax_product_registrations_resource_country_options_default"]; th?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; + tj?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; tr?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; tz?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; + ug?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; us?: components["schemas"]["tax_product_registrations_resource_country_options_united_states"]; + uy?: components["schemas"]["tax_product_registrations_resource_country_options_default"]; uz?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; vn?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; za?: components["schemas"]["tax_product_registrations_resource_country_options_default"]; + zm?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; + zw?: components["schemas"]["tax_product_registrations_resource_country_options_default"]; }; /** TaxProductRegistrationsResourceCountryOptionsCaProvinceStandard */ tax_product_registrations_resource_country_options_ca_province_standard: { @@ -24962,10 +25279,10 @@ export interface components { /** TaxProductResourceCustomerDetailsResourceTaxId */ tax_product_resource_customer_details_resource_tax_id: { /** - * @description The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, or `unknown` + * @description The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, or `unknown` * @enum {string} */ - type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "by_tin" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "li_vat" | "ma_vat" | "md_vat" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "tz_vat" | "ua_vat" | "unknown" | "us_ein" | "uy_ruc" | "uz_tin" | "uz_vat" | "ve_rif" | "vn_tin" | "za_vat"; + type: "ad_nrt" | "ae_trn" | "al_tin" | "am_tin" | "ao_tin" | "ar_cuit" | "au_abn" | "au_arn" | "ba_tin" | "bb_tin" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "bs_tin" | "by_tin" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "cd_nif" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "gn_nif" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kh_tin" | "kr_brn" | "kz_bin" | "li_uid" | "li_vat" | "ma_vat" | "md_vat" | "me_pib" | "mk_vat" | "mr_nif" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "np_pan" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sn_ninea" | "sr_fin" | "sv_nit" | "th_vat" | "tj_tin" | "tr_tin" | "tw_vat" | "tz_vat" | "ua_vat" | "ug_tin" | "unknown" | "us_ein" | "uy_ruc" | "uz_tin" | "uz_vat" | "ve_rif" | "vn_tin" | "za_vat" | "zm_tin" | "zw_tin"; /** @description The value of the tax ID. */ value: string; }; @@ -25373,7 +25690,10 @@ export interface components { * @description Represents a cart to be displayed on the reader */ terminal_reader_reader_resource_cart: { - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description List of line items in the cart. */ line_items: components["schemas"]["terminal_reader_reader_resource_line_item"][]; @@ -25789,7 +26109,10 @@ export interface components { * @description Time that this record of the transfer was first created. */ created: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ description?: string | null; @@ -25871,7 +26194,10 @@ export interface components { * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ created: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description Linked payment refund for the transfer reversal. */ destination_payment_refund?: (string | components["schemas"]["refund"]) | null; @@ -25934,7 +26260,10 @@ export interface components { * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ created: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description The FinancialAccount to reverse funds from. */ financial_account: string; @@ -25981,7 +26310,10 @@ export interface components { * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ created: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description The FinancialAccount to reverse funds from. */ financial_account?: string | null; @@ -26100,7 +26432,10 @@ export interface components { * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ created: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ description?: string | null; @@ -26159,7 +26494,10 @@ export interface components { * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ created: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description ID of the [customer](https://stripe.com/docs/api/customers) to whom an OutboundPayment is sent. */ customer?: string | null; @@ -26226,7 +26564,10 @@ export interface components { * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ created: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ description?: string | null; @@ -26282,7 +26623,10 @@ export interface components { * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ created: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ description: string; @@ -26333,7 +26677,10 @@ export interface components { * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ created: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ description: string; @@ -26385,7 +26732,10 @@ export interface components { * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ created: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ description: string; @@ -26444,7 +26794,10 @@ export interface components { * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ created: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** * Format: unix-time @@ -26510,21 +26863,6 @@ export interface components { /** @description Additional details; includes at least one entry when the status is not `active`. */ status_details: components["schemas"]["treasury_financial_accounts_resource_toggles_setting_status_details"][]; }; - /** - * TreasuryFinancialAccountsResourceAchToggleSettings - * @description Toggle settings for enabling/disabling an ACH specific feature - */ - treasury_financial_accounts_resource_ach_toggle_settings: { - /** @description Whether the FinancialAccount should have the Feature. */ - requested: boolean; - /** - * @description Whether the Feature is operational. - * @enum {string} - */ - status: "active" | "pending" | "restricted"; - /** @description Additional details; includes at least one entry when the status is not `active`. */ - status_details: components["schemas"]["treasury_financial_accounts_resource_toggles_setting_status_details"][]; - }; /** * TreasuryFinancialAccountsResourceBalance * @description Balance information for the FinancialAccount @@ -26569,19 +26907,49 @@ export interface components { treasury_financial_accounts_resource_financial_addresses_features: { aba?: components["schemas"]["treasury_financial_accounts_resource_aba_toggle_settings"]; }; + /** + * TreasuryFinancialAccountsResourceInboundAchToggleSettings + * @description Toggle settings for enabling/disabling an inbound ACH specific feature + */ + treasury_financial_accounts_resource_inbound_ach_toggle_settings: { + /** @description Whether the FinancialAccount should have the Feature. */ + requested: boolean; + /** + * @description Whether the Feature is operational. + * @enum {string} + */ + status: "active" | "pending" | "restricted"; + /** @description Additional details; includes at least one entry when the status is not `active`. */ + status_details: components["schemas"]["treasury_financial_accounts_resource_toggles_setting_status_details"][]; + }; /** * TreasuryFinancialAccountsResourceInboundTransfers * @description InboundTransfers contains inbound transfers features for a FinancialAccount. */ treasury_financial_accounts_resource_inbound_transfers: { - ach?: components["schemas"]["treasury_financial_accounts_resource_ach_toggle_settings"]; + ach?: components["schemas"]["treasury_financial_accounts_resource_inbound_ach_toggle_settings"]; + }; + /** + * TreasuryFinancialAccountsResourceOutboundAchToggleSettings + * @description Toggle settings for enabling/disabling an outbound ACH specific feature + */ + treasury_financial_accounts_resource_outbound_ach_toggle_settings: { + /** @description Whether the FinancialAccount should have the Feature. */ + requested: boolean; + /** + * @description Whether the Feature is operational. + * @enum {string} + */ + status: "active" | "pending" | "restricted"; + /** @description Additional details; includes at least one entry when the status is not `active`. */ + status_details: components["schemas"]["treasury_financial_accounts_resource_toggles_setting_status_details"][]; }; /** * TreasuryFinancialAccountsResourceOutboundPayments * @description Settings related to Outbound Payments features on a Financial Account */ treasury_financial_accounts_resource_outbound_payments: { - ach?: components["schemas"]["treasury_financial_accounts_resource_ach_toggle_settings"]; + ach?: components["schemas"]["treasury_financial_accounts_resource_outbound_ach_toggle_settings"]; us_domestic_wire?: components["schemas"]["treasury_financial_accounts_resource_toggle_settings"]; }; /** @@ -26589,7 +26957,7 @@ export interface components { * @description OutboundTransfers contains outbound transfers features for a FinancialAccount. */ treasury_financial_accounts_resource_outbound_transfers: { - ach?: components["schemas"]["treasury_financial_accounts_resource_ach_toggle_settings"]; + ach?: components["schemas"]["treasury_financial_accounts_resource_outbound_ach_toggle_settings"]; us_domestic_wire?: components["schemas"]["treasury_financial_accounts_resource_toggle_settings"]; }; /** @@ -27402,6 +27770,7 @@ export interface operations { /** @enum {string} */ account_type?: "checking" | "futsu" | "savings" | "toza"; country: string; + /** Format: currency */ currency?: string; /** external_account_documents_param */ documents?: { @@ -27422,6 +27791,7 @@ export interface operations { /** annual_revenue_specs */ annual_revenue?: { amount: number; + /** Format: currency */ currency: string; fiscal_year_end: string; }; @@ -27430,6 +27800,7 @@ export interface operations { /** monthly_estimated_revenue_specs */ monthly_estimated_revenue?: { amount: number; + /** Format: currency */ currency: string; }; name?: string; @@ -27768,7 +28139,10 @@ export interface operations { }; /** @description The country in which the account holder resides, or in which the business is legally established. This should be an ISO 3166-1 alpha-2 country code. For example, if you are in the United States and the business for which you're creating an account is legally represented in Canada, you would use `CA` as the country for the account being created. Available countries include [Stripe's global markets](https://stripe.com/global) as well as countries where [cross-border payouts](https://stripe.com/docs/connect/cross-border-payouts) are supported. */ country?: string; - /** @description Three-letter ISO currency code representing the default currency for the account. This must be a currency that [Stripe supports in the account's country](https://docs.stripe.com/payouts). */ + /** + * Format: currency + * @description Three-letter ISO currency code representing the default currency for the account. This must be a currency that [Stripe supports in the account's country](https://docs.stripe.com/payouts). + */ default_currency?: string; /** * documents_specs @@ -27812,7 +28186,7 @@ export interface operations { external_account?: string; /** * account_groups_specs - * @description A hash of account group type to tokens. These are account groups this account should be added to + * @description A hash of account group type to tokens. These are account groups this account should be added to. */ groups?: { payments_pricing?: string | ""; @@ -28071,13 +28445,14 @@ export interface operations { /** @description An [account token](https://stripe.com/docs/api#create_account_token), used to securely provide details to the account. */ account_token?: string; /** - * business_profile_specs + * business_profile_update_specs * @description Business information about the account. */ business_profile?: { /** annual_revenue_specs */ annual_revenue?: { amount: number; + /** Format: currency */ currency: string; fiscal_year_end: string; }; @@ -28086,6 +28461,7 @@ export interface operations { /** monthly_estimated_revenue_specs */ monthly_estimated_revenue?: { amount: number; + /** Format: currency */ currency: string; }; name?: string; @@ -28335,7 +28711,7 @@ export interface operations { }; }; /** - * company_specs + * company_update_specs * @description Information about the company or business. This field is available for any `business_type`. Once you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. */ company?: { @@ -28399,7 +28775,10 @@ export interface operations { }; }; }; - /** @description Three-letter ISO currency code representing the default currency for the account. This must be a currency that [Stripe supports in the account's country](https://docs.stripe.com/payouts). */ + /** + * Format: currency + * @description Three-letter ISO currency code representing the default currency for the account. This must be a currency that [Stripe supports in the account's country](https://docs.stripe.com/payouts). + */ default_currency?: string; /** * documents_specs @@ -28443,13 +28822,13 @@ export interface operations { external_account?: string; /** * account_groups_specs - * @description A hash of account group type to tokens. These are account groups this account should be added to + * @description A hash of account group type to tokens. These are account groups this account should be added to. */ groups?: { payments_pricing?: string | ""; }; /** - * individual_specs + * individual_update_specs * @description Information about the person represented by the account. This field is null unless `business_type` is set to `individual`. Once you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. */ individual?: { @@ -28704,6 +29083,7 @@ export interface operations { /** @enum {string} */ account_type?: "checking" | "futsu" | "savings" | "toza"; country: string; + /** Format: currency */ currency?: string; /** external_account_documents_param */ documents?: { @@ -29120,6 +29500,7 @@ export interface operations { /** @enum {string} */ account_type?: "checking" | "futsu" | "savings" | "toza"; country: string; + /** Format: currency */ currency?: string; /** external_account_documents_param */ documents?: { @@ -29375,6 +29756,7 @@ export interface operations { limit?: number; /** @description Filters on the list of people returned based on the person's relationship to the account's company. */ relationship?: { + authorizer?: boolean; director?: boolean; executive?: boolean; legal_guardian?: boolean; @@ -29569,6 +29951,7 @@ export interface operations { * @description The relationship that this person has with the account's legal entity. */ relationship?: { + authorizer?: boolean; director?: boolean; executive?: boolean; legal_guardian?: boolean; @@ -29801,6 +30184,7 @@ export interface operations { * @description The relationship that this person has with the account's legal entity. */ relationship?: { + authorizer?: boolean; director?: boolean; executive?: boolean; legal_guardian?: boolean; @@ -29898,6 +30282,7 @@ export interface operations { limit?: number; /** @description Filters on the list of people returned based on the person's relationship to the account's company. */ relationship?: { + authorizer?: boolean; director?: boolean; executive?: boolean; legal_guardian?: boolean; @@ -30092,6 +30477,7 @@ export interface operations { * @description The relationship that this person has with the account's legal entity. */ relationship?: { + authorizer?: boolean; director?: boolean; executive?: boolean; legal_guardian?: boolean; @@ -30324,6 +30710,7 @@ export interface operations { * @description The relationship that this person has with the account's legal entity. */ relationship?: { + authorizer?: boolean; director?: boolean; executive?: boolean; legal_guardian?: boolean; @@ -31200,7 +31587,7 @@ export interface operations { source?: string; /** @description A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ starting_after?: string; - /** @description Only returns transactions of the given type. One of: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `climate_order_purchase`, `climate_order_refund`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_outbound`, `obligation_reversal_inbound`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`. */ + /** @description Only returns transactions of the given type. One of: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `climate_order_purchase`, `climate_order_refund`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_outbound`, `obligation_reversal_inbound`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `payout_minimum_balance_hold`, `payout_minimum_balance_release`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`. */ type?: string; }; header?: never; @@ -31306,7 +31693,7 @@ export interface operations { source?: string; /** @description A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ starting_after?: string; - /** @description Only returns transactions of the given type. One of: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `climate_order_purchase`, `climate_order_refund`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_outbound`, `obligation_reversal_inbound`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`. */ + /** @description Only returns transactions of the given type. One of: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `climate_order_purchase`, `climate_order_refund`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_outbound`, `obligation_reversal_inbound`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `payout_minimum_balance_hold`, `payout_minimum_balance_release`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`. */ type?: string; }; header?: never; @@ -31872,6 +32259,7 @@ export interface operations { amount: { /** monetary_amount_param */ monetary?: { + /** Format: currency */ currency: string; value: number; }; @@ -31898,17 +32286,17 @@ export interface operations { customer: string; /** * Format: unix-time - * @description The time when the billing credits become effective—when they're eligible for use. Defaults to the current timestamp if not specified. + * @description The time when the billing credits become effective-when they're eligible for use. It defaults to the current timestamp if not specified. */ effective_at?: number; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; /** * Format: unix-time - * @description The time when the billing credits will expire. If not specified, the billing credits don't expire. + * @description The time when the billing credits expire. If not specified, the billing credits don't expire. */ expires_at?: number; - /** @description Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object (for example, cost basis) in a structured format. */ + /** @description Set of key-value pairs that you can attach to an object. You can use this to store additional information about the object (for example, cost basis) in a structured format. */ metadata?: { [key: string]: string; }; @@ -31994,7 +32382,7 @@ export interface operations { expand?: string[]; /** @description The time when the billing credits created by this credit grant expire. If set to empty, the billing credits never expire. */ expires_at?: number | ""; - /** @description Set of key-value pairs you can attach to an object. This can be useful for storing additional information about the object (for example, cost basis) in a structured format. */ + /** @description Set of key-value pairs you can attach to an object. You can use this to store additional information about the object (for example, cost basis) in a structured format. */ metadata?: { [key: string]: string; }; @@ -32164,7 +32552,7 @@ export interface operations { event_name: string; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; - /** @description A unique identifier for the event. If not provided, one will be generated. We strongly advise using UUID-like identifiers. We will enforce uniqueness within a rolling period of at least 24 hours. The enforcement of uniqueness primarily addresses issues arising from accidental retries or other problems occurring within extremely brief time intervals. This approach helps prevent duplicate entries and ensures data integrity in high-frequency operations. */ + /** @description A unique identifier for the event. If not provided, one is generated. We recommend using UUID-like identifiers. We will enforce uniqueness within a rolling period of at least 24 hours. The enforcement of uniqueness primarily addresses issues arising from accidental retries or other problems occurring within extremely brief time intervals. This approach helps prevent duplicate entries and ensures data integrity in high-frequency operations. */ identifier?: string; /** @description The payload of the event. This must contain the fields corresponding to a meter's `customer_mapping.event_payload_key` (default is `stripe_customer_id`) and `value_settings.event_payload_key` (default is `value`). Read more about the [payload](https://docs.stripe.com/billing/subscriptions/usage-based/recording-usage#payload-key-overrides). */ payload: { @@ -32281,7 +32669,7 @@ export interface operations { /** @enum {string} */ formula: "count" | "sum"; }; - /** @description The meter's name. */ + /** @description The meter’s name. Not visible to the customer. */ display_name: string; /** @description The name of the meter event to record usage for. Corresponds with the `event_name` field on meter events. */ event_name: string; @@ -32375,7 +32763,7 @@ export interface operations { requestBody?: { content: { "application/x-www-form-urlencoded": { - /** @description The meter's name. */ + /** @description The meter’s name. Not visible to the customer. */ display_name?: string; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; @@ -33062,7 +33450,10 @@ export interface operations { /** @enum {string} */ object?: "card"; } | string; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency?: string; /** @description The ID of an existing customer that will be charged in this request. */ customer?: string; @@ -33490,6 +33881,10 @@ export interface operations { }; }[]; }; + /** visa_compliance */ + visa_compliance?: { + fee_acknowledged?: boolean; + }; } | ""; product_description?: string; receipt?: string; @@ -33704,7 +34099,10 @@ export interface operations { content: { "application/x-www-form-urlencoded": { amount?: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency?: string; /** @description Customer whose customer balance to refund from. */ customer?: string; @@ -33980,7 +34378,10 @@ export interface operations { /** @enum {string} */ terms_of_service?: "none" | "required"; }; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Required in `setup` mode when `payment_method_types` is not set. */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Required in `setup` mode when `payment_method_types` is not set. + */ currency?: string; /** @description Collect additional information from your customer using custom fields. Up to 3 fields are supported. */ custom_fields?: { @@ -34134,6 +34535,7 @@ export interface operations { price?: string; /** price_data_with_product_data */ price_data?: { + /** Format: currency */ currency: string; product?: string; /** product_data */ @@ -34288,7 +34690,9 @@ export interface operations { /** payment_method_options_param */ bacs_debit?: { /** payment_method_options_mandate_options_param */ - mandate_options?: Record; + mandate_options?: { + reference_prefix?: string | ""; + }; /** @enum {string} */ setup_future_usage?: "none" | "off_session" | "on_session"; }; @@ -34468,7 +34872,9 @@ export interface operations { /** payment_method_options_param */ sepa_debit?: { /** payment_method_options_mandate_options_param */ - mandate_options?: Record; + mandate_options?: { + reference_prefix?: string | ""; + }; /** @enum {string} */ setup_future_usage?: "none" | "off_session" | "on_session"; }; @@ -34584,6 +34990,7 @@ export interface operations { /** fixed_amount */ fixed_amount?: { amount: number; + /** Format: currency */ currency: string; currency_options?: { [key: string]: { @@ -35496,7 +35903,10 @@ export interface operations { applies_to?: { products?: string[]; }; - /** @description Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the `amount_off` parameter (required if `amount_off` is passed). */ + /** + * Format: currency + * @description Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the `amount_off` parameter (required if `amount_off` is passed). + */ currency?: string; /** @description Coupons defined in each available currency option (only supported if `amount_off` is passed). Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies). */ currency_options?: { @@ -36431,7 +36841,7 @@ export interface operations { /** @description The customer's tax IDs. */ tax_id_data?: { /** @enum {string} */ - type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "by_tin" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "li_vat" | "ma_vat" | "md_vat" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "tz_vat" | "ua_vat" | "us_ein" | "uy_ruc" | "uz_tin" | "uz_vat" | "ve_rif" | "vn_tin" | "za_vat"; + type: "ad_nrt" | "ae_trn" | "al_tin" | "am_tin" | "ao_tin" | "ar_cuit" | "au_abn" | "au_arn" | "ba_tin" | "bb_tin" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "bs_tin" | "by_tin" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "cd_nif" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "gn_nif" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kh_tin" | "kr_brn" | "kz_bin" | "li_uid" | "li_vat" | "ma_vat" | "md_vat" | "me_pib" | "mk_vat" | "mr_nif" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "np_pan" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sn_ninea" | "sr_fin" | "sv_nit" | "th_vat" | "tj_tin" | "tr_tin" | "tw_vat" | "tz_vat" | "ua_vat" | "ug_tin" | "us_ein" | "uy_ruc" | "uz_tin" | "uz_vat" | "ve_rif" | "vn_tin" | "za_vat" | "zm_tin" | "zw_tin"; value: string; }[]; /** @description ID of the test clock to attach to the customer. */ @@ -36582,6 +36992,7 @@ export interface operations { account_holder_type?: "company" | "individual"; account_number: string; country: string; + /** Format: currency */ currency?: string; /** @enum {string} */ object?: "bank_account"; @@ -36827,7 +37238,10 @@ export interface operations { "application/x-www-form-urlencoded": { /** @description The integer amount in **cents (or local equivalent)** to apply to the customer's credit balance. */ amount: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Specifies the [`invoice_credit_balance`](https://stripe.com/docs/api/customers/object#customer_object-invoice_credit_balance) that this transaction will apply to. If the customer's `currency` is not set, it will be updated to this value. */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Specifies the [`invoice_credit_balance`](https://stripe.com/docs/api/customers/object#customer_object-invoice_credit_balance) that this transaction will apply to. If the customer's `currency` is not set, it will be updated to this value. + */ currency: string; /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ description?: string; @@ -37022,6 +37436,7 @@ export interface operations { account_holder_type?: "company" | "individual"; account_number: string; country: string; + /** Format: currency */ currency?: string; /** @enum {string} */ object?: "bank_account"; @@ -37356,6 +37771,7 @@ export interface operations { account_holder_type?: "company" | "individual"; account_number: string; country: string; + /** Format: currency */ currency?: string; /** @enum {string} */ object?: "bank_account"; @@ -37850,7 +38266,10 @@ export interface operations { /** @enum {string} */ type: "eu_bank_transfer" | "gb_bank_transfer" | "jp_bank_transfer" | "mx_bank_transfer" | "us_bank_transfer"; }; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; @@ -38060,6 +38479,7 @@ export interface operations { account_holder_type?: "company" | "individual"; account_number: string; country: string; + /** Format: currency */ currency?: string; /** @enum {string} */ object?: "bank_account"; @@ -38396,6 +38816,7 @@ export interface operations { price?: string; /** one_time_price_data_with_negative_amounts */ price_data?: { + /** Format: currency */ currency: string; product: string; /** @enum {string} */ @@ -38451,7 +38872,10 @@ export interface operations { collection_method?: "charge_automatically" | "send_invoice"; /** @description The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription. This field has been deprecated and will be removed in a future API version. Use `discounts` instead. */ coupon?: string; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency?: string; /** @description Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`. */ days_until_due?: number; @@ -38498,6 +38922,7 @@ export interface operations { price?: string; /** recurring_price_data */ price_data?: { + /** Format: currency */ currency: string; product: string; /** recurring_adhoc */ @@ -38724,6 +39149,7 @@ export interface operations { price?: string; /** one_time_price_data_with_negative_amounts */ price_data?: { + /** Format: currency */ currency: string; product: string; /** @enum {string} */ @@ -38828,6 +39254,7 @@ export interface operations { price?: string; /** recurring_price_data */ price_data?: { + /** Format: currency */ currency: string; product: string; /** recurring_adhoc */ @@ -39184,10 +39611,10 @@ export interface operations { /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; /** - * @description Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, or `za_vat` + * @description Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `ba_tin`, `bb_tin`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kh_tin`, `kr_brn`, `kz_bin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin` * @enum {string} */ - type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "by_tin" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "li_vat" | "ma_vat" | "md_vat" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "tz_vat" | "ua_vat" | "us_ein" | "uy_ruc" | "uz_tin" | "uz_vat" | "ve_rif" | "vn_tin" | "za_vat"; + type: "ad_nrt" | "ae_trn" | "al_tin" | "am_tin" | "ao_tin" | "ar_cuit" | "au_abn" | "au_arn" | "ba_tin" | "bb_tin" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "bs_tin" | "by_tin" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "cd_nif" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "gn_nif" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kh_tin" | "kr_brn" | "kz_bin" | "li_uid" | "li_vat" | "ma_vat" | "md_vat" | "me_pib" | "mk_vat" | "mr_nif" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "np_pan" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sn_ninea" | "sr_fin" | "sv_nit" | "th_vat" | "tj_tin" | "tr_tin" | "tw_vat" | "tz_vat" | "ua_vat" | "ug_tin" | "us_ein" | "uy_ruc" | "uz_tin" | "uz_vat" | "ve_rif" | "vn_tin" | "za_vat" | "zm_tin" | "zw_tin"; /** @description Value of the tax ID. */ value: string; }; @@ -39463,6 +39890,10 @@ export interface operations { }; }[]; }; + /** visa_compliance */ + visa_compliance?: { + fee_acknowledged?: boolean; + }; } | ""; product_description?: string; receipt?: string; @@ -41057,7 +41488,7 @@ export interface operations { /** @description The PaymentMethod to insert into the forwarded request. Forwarding previously consumed PaymentMethods is allowed. */ payment_method: string; /** @description The field kinds to be replaced in the forwarded request. */ - replacements: ("card_cvc" | "card_expiry" | "card_number" | "cardholder_name")[]; + replacements: ("card_cvc" | "card_expiry" | "card_number" | "cardholder_name" | "request_signature")[]; /** * request_param * @description The request body and headers to be sent to the destination endpoint. @@ -41804,7 +42235,10 @@ export interface operations { "application/x-www-form-urlencoded": { /** @description The integer amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. Passing in a negative `amount` will reduce the `amount_due` on the invoice. */ amount?: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency?: string; /** @description The ID of the customer who will be billed when this invoice item is billed. */ customer: string; @@ -41843,6 +42277,7 @@ export interface operations { * @description Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required. */ price_data?: { + /** Format: currency */ currency: string; product: string; /** @enum {string} */ @@ -41980,6 +42415,7 @@ export interface operations { * @description Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required. */ price_data?: { + /** Format: currency */ currency: string; product: string; /** @enum {string} */ @@ -42178,7 +42614,10 @@ export interface operations { * @enum {string} */ collection_method?: "charge_automatically" | "send_invoice"; - /** @description The currency to create this invoice in. Defaults to that of `customer` if not specified. */ + /** + * Format: currency + * @description The currency to create this invoice in. Defaults to that of `customer` if not specified. + */ currency?: string; /** @description A list of up to 4 custom fields to be displayed on the invoice. */ custom_fields?: { @@ -42355,6 +42794,7 @@ export interface operations { /** fixed_amount */ fixed_amount?: { amount: number; + /** Format: currency */ currency: string; currency_options?: { [key: string]: { @@ -42452,7 +42892,10 @@ export interface operations { }; /** @description The ID of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead. */ coupon?: string; - /** @description The currency to preview this invoice in. Defaults to that of `customer` if not specified. */ + /** + * Format: currency + * @description The currency to preview this invoice in. Defaults to that of `customer` if not specified. + */ currency?: string; /** @description The identifier of the customer whose upcoming invoice you'd like to retrieve. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set. */ customer?: string; @@ -42490,7 +42933,7 @@ export interface operations { tax_exempt?: "" | "exempt" | "none" | "reverse"; tax_ids?: { /** @enum {string} */ - type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "by_tin" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "li_vat" | "ma_vat" | "md_vat" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "tz_vat" | "ua_vat" | "us_ein" | "uy_ruc" | "uz_tin" | "uz_vat" | "ve_rif" | "vn_tin" | "za_vat"; + type: "ad_nrt" | "ae_trn" | "al_tin" | "am_tin" | "ao_tin" | "ar_cuit" | "au_abn" | "au_arn" | "ba_tin" | "bb_tin" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "bs_tin" | "by_tin" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "cd_nif" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "gn_nif" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kh_tin" | "kr_brn" | "kz_bin" | "li_uid" | "li_vat" | "ma_vat" | "md_vat" | "me_pib" | "mk_vat" | "mr_nif" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "np_pan" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sn_ninea" | "sr_fin" | "sv_nit" | "th_vat" | "tj_tin" | "tr_tin" | "tw_vat" | "tz_vat" | "ua_vat" | "ug_tin" | "us_ein" | "uy_ruc" | "uz_tin" | "uz_vat" | "ve_rif" | "vn_tin" | "za_vat" | "zm_tin" | "zw_tin"; value: string; }[]; }; @@ -42505,6 +42948,7 @@ export interface operations { /** @description List of invoice items to add or update in the upcoming invoice preview (up to 250). */ invoice_items?: { amount?: number; + /** Format: currency */ currency?: string; description?: string; discountable?: boolean; @@ -42527,6 +42971,7 @@ export interface operations { price?: string; /** one_time_price_data */ price_data?: { + /** Format: currency */ currency: string; product: string; /** @enum {string} */ @@ -42579,6 +43024,7 @@ export interface operations { price?: string; /** one_time_price_data_with_negative_amounts */ price_data?: { + /** Format: currency */ currency: string; product: string; /** @enum {string} */ @@ -42645,6 +43091,7 @@ export interface operations { price?: string; /** recurring_price_data */ price_data?: { + /** Format: currency */ currency: string; product: string; /** recurring_adhoc */ @@ -42711,6 +43158,7 @@ export interface operations { price?: string; /** recurring_price_data */ price_data?: { + /** Format: currency */ currency: string; product: string; /** recurring_adhoc */ @@ -42866,7 +43314,7 @@ export interface operations { tax_exempt?: "" | "exempt" | "none" | "reverse"; tax_ids?: { /** @enum {string} */ - type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "by_tin" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "li_vat" | "ma_vat" | "md_vat" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "tz_vat" | "ua_vat" | "us_ein" | "uy_ruc" | "uz_tin" | "uz_vat" | "ve_rif" | "vn_tin" | "za_vat"; + type: "ad_nrt" | "ae_trn" | "al_tin" | "am_tin" | "ao_tin" | "ar_cuit" | "au_abn" | "au_arn" | "ba_tin" | "bb_tin" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "bs_tin" | "by_tin" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "cd_nif" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "gn_nif" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kh_tin" | "kr_brn" | "kz_bin" | "li_uid" | "li_vat" | "ma_vat" | "md_vat" | "me_pib" | "mk_vat" | "mr_nif" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "np_pan" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sn_ninea" | "sr_fin" | "sv_nit" | "th_vat" | "tj_tin" | "tr_tin" | "tw_vat" | "tz_vat" | "ua_vat" | "ug_tin" | "us_ein" | "uy_ruc" | "uz_tin" | "uz_vat" | "ve_rif" | "vn_tin" | "za_vat" | "zm_tin" | "zw_tin"; value: string; }[]; }; @@ -42881,6 +43329,7 @@ export interface operations { /** @description List of invoice items to add or update in the upcoming invoice preview (up to 250). */ invoice_items?: { amount?: number; + /** Format: currency */ currency?: string; description?: string; discountable?: boolean; @@ -42903,6 +43352,7 @@ export interface operations { price?: string; /** one_time_price_data */ price_data?: { + /** Format: currency */ currency: string; product: string; /** @enum {string} */ @@ -42946,6 +43396,7 @@ export interface operations { price?: string; /** one_time_price_data_with_negative_amounts */ price_data?: { + /** Format: currency */ currency: string; product: string; /** @enum {string} */ @@ -43012,6 +43463,7 @@ export interface operations { price?: string; /** recurring_price_data */ price_data?: { + /** Format: currency */ currency: string; product: string; /** recurring_adhoc */ @@ -43085,6 +43537,7 @@ export interface operations { price?: string; /** recurring_price_data */ price_data?: { + /** Format: currency */ currency: string; product: string; /** recurring_adhoc */ @@ -43131,6 +43584,7 @@ export interface operations { price?: string; /** recurring_price_data */ price_data?: { + /** Format: currency */ currency: string; product: string; /** recurring_adhoc */ @@ -43239,7 +43693,7 @@ export interface operations { tax_exempt?: "" | "exempt" | "none" | "reverse"; tax_ids?: { /** @enum {string} */ - type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "by_tin" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "li_vat" | "ma_vat" | "md_vat" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "tz_vat" | "ua_vat" | "us_ein" | "uy_ruc" | "uz_tin" | "uz_vat" | "ve_rif" | "vn_tin" | "za_vat"; + type: "ad_nrt" | "ae_trn" | "al_tin" | "am_tin" | "ao_tin" | "ar_cuit" | "au_abn" | "au_arn" | "ba_tin" | "bb_tin" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "bs_tin" | "by_tin" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "cd_nif" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "gn_nif" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kh_tin" | "kr_brn" | "kz_bin" | "li_uid" | "li_vat" | "ma_vat" | "md_vat" | "me_pib" | "mk_vat" | "mr_nif" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "np_pan" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sn_ninea" | "sr_fin" | "sv_nit" | "th_vat" | "tj_tin" | "tr_tin" | "tw_vat" | "tz_vat" | "ua_vat" | "ug_tin" | "us_ein" | "uy_ruc" | "uz_tin" | "uz_vat" | "ve_rif" | "vn_tin" | "za_vat" | "zm_tin" | "zw_tin"; value: string; }[]; }; @@ -43256,6 +43710,7 @@ export interface operations { /** @description List of invoice items to add or update in the upcoming invoice preview (up to 250). */ invoice_items?: { amount?: number; + /** Format: currency */ currency?: string; description?: string; discountable?: boolean; @@ -43278,6 +43733,7 @@ export interface operations { price?: string; /** one_time_price_data */ price_data?: { + /** Format: currency */ currency: string; product: string; /** @enum {string} */ @@ -43323,6 +43779,7 @@ export interface operations { price?: string; /** one_time_price_data_with_negative_amounts */ price_data?: { + /** Format: currency */ currency: string; product: string; /** @enum {string} */ @@ -43389,6 +43846,7 @@ export interface operations { price?: string; /** recurring_price_data */ price_data?: { + /** Format: currency */ currency: string; product: string; /** recurring_adhoc */ @@ -43464,6 +43922,7 @@ export interface operations { price?: string; /** recurring_price_data */ price_data?: { + /** Format: currency */ currency: string; product: string; /** recurring_adhoc */ @@ -43510,6 +43969,7 @@ export interface operations { price?: string; /** recurring_price_data */ price_data?: { + /** Format: currency */ currency: string; product: string; /** recurring_adhoc */ @@ -43812,6 +44272,7 @@ export interface operations { /** fixed_amount */ fixed_amount?: { amount: number; + /** Format: currency */ currency: string; currency_options?: { [key: string]: { @@ -43953,6 +44414,7 @@ export interface operations { price?: string; /** one_time_price_data_with_product_data */ price_data?: { + /** Format: currency */ currency: string; product?: string; /** product_data */ @@ -44160,6 +44622,7 @@ export interface operations { * @description Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required. */ price_data?: { + /** Format: currency */ currency: string; product?: string; /** product_data */ @@ -44441,6 +44904,7 @@ export interface operations { price?: string; /** one_time_price_data_with_product_data */ price_data?: { + /** Format: currency */ currency: string; product?: string; /** product_data */ @@ -47021,7 +47485,10 @@ export interface operations { * * If the provided ConfirmationToken contains properties that are also being provided in this request, such as `payment_method`, then the values in this request will take precedence. */ confirmation_token?: string; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description ID of the Customer this PaymentIntent belongs to, if one exists. * @@ -47288,7 +47755,9 @@ export interface operations { } | ""; bacs_debit?: { /** payment_method_options_mandate_options_param */ - mandate_options?: Record; + mandate_options?: { + reference_prefix?: string | ""; + }; /** @enum {string} */ setup_future_usage?: "" | "none" | "off_session" | "on_session"; } | ""; @@ -47532,7 +48001,9 @@ export interface operations { } | ""; sepa_debit?: { /** payment_method_options_mandate_options_param */ - mandate_options?: Record; + mandate_options?: { + reference_prefix?: string | ""; + }; /** @enum {string} */ setup_future_usage?: "" | "none" | "off_session" | "on_session"; } | ""; @@ -47791,7 +48262,10 @@ export interface operations { * @enum {string} */ capture_method?: "automatic" | "automatic_async" | "manual"; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency?: string; /** @description ID of the Customer this PaymentIntent belongs to, if one exists. * @@ -48031,7 +48505,9 @@ export interface operations { } | ""; bacs_debit?: { /** payment_method_options_mandate_options_param */ - mandate_options?: Record; + mandate_options?: { + reference_prefix?: string | ""; + }; /** @enum {string} */ setup_future_usage?: "" | "none" | "off_session" | "on_session"; } | ""; @@ -48275,7 +48751,9 @@ export interface operations { } | ""; sepa_debit?: { /** payment_method_options_mandate_options_param */ - mandate_options?: Record; + mandate_options?: { + reference_prefix?: string | ""; + }; /** @enum {string} */ setup_future_usage?: "" | "none" | "off_session" | "on_session"; } | ""; @@ -48423,7 +48901,10 @@ export interface operations { * * When you omit the amount, it defaults to the remaining amount requested on the PaymentIntent. */ amount?: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency?: string; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; @@ -48836,7 +49317,9 @@ export interface operations { } | ""; bacs_debit?: { /** payment_method_options_mandate_options_param */ - mandate_options?: Record; + mandate_options?: { + reference_prefix?: string | ""; + }; /** @enum {string} */ setup_future_usage?: "" | "none" | "off_session" | "on_session"; } | ""; @@ -49080,7 +49563,9 @@ export interface operations { } | ""; sepa_debit?: { /** payment_method_options_mandate_options_param */ - mandate_options?: Record; + mandate_options?: { + reference_prefix?: string | ""; + }; /** @enum {string} */ setup_future_usage?: "" | "none" | "off_session" | "on_session"; } | ""; @@ -49430,7 +49915,10 @@ export interface operations { /** @enum {string} */ terms_of_service?: "none" | "required"; }; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies) and supported by each line item's price. */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies) and supported by each line item's price. + */ currency?: string; /** @description Collect additional information from your customer using custom fields. Up to 3 fields are supported. */ custom_fields?: { @@ -49915,6 +50403,7 @@ export interface operations { metadata?: { [key: string]: string; } | ""; + trial_period_days?: number | ""; trial_settings?: { /** end_behavior */ end_behavior: { @@ -52034,7 +52523,10 @@ export interface operations { "application/x-www-form-urlencoded": { /** @description A positive integer in cents representing how much to payout. */ amount: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ description?: string; @@ -52336,7 +52828,10 @@ export interface operations { * @enum {string} */ billing_scheme?: "per_unit" | "tiered"; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; @@ -52643,7 +53138,10 @@ export interface operations { * @enum {string} */ billing_scheme?: "per_unit" | "tiered"; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description Prices defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies). */ currency_options?: { @@ -53044,6 +53542,7 @@ export interface operations { * @description Data used to generate a new [Price](https://stripe.com/docs/api/prices) object. This Price will be set as the default price for this product. */ default_price_data?: { + /** Format: currency */ currency: string; currency_options?: { [key: string]: { @@ -53642,6 +54141,7 @@ export interface operations { }; first_time_transaction?: boolean; minimum_amount?: number; + /** Format: currency */ minimum_amount_currency?: string; }; }; @@ -53906,6 +54406,7 @@ export interface operations { price?: string; /** price_data */ price_data?: { + /** Format: currency */ currency: string; product: string; /** recurring_adhoc */ @@ -54092,6 +54593,7 @@ export interface operations { price?: string; /** price_data */ price_data?: { + /** Format: currency */ currency: string; product: string; /** recurring_adhoc */ @@ -55014,7 +55516,10 @@ export interface operations { amount?: number; /** @description The identifier of the charge to refund. */ charge?: string; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency?: string; /** @description Customer whose customer balance to refund from. */ customer?: string; @@ -55263,6 +55768,7 @@ export interface operations { parameters?: { columns?: string[]; connected_account?: string; + /** Format: currency */ currency?: string; /** Format: unix-time */ interval_end?: number; @@ -55952,7 +56458,9 @@ export interface operations { /** setup_intent_payment_method_options_param */ bacs_debit?: { /** payment_method_options_mandate_options_param */ - mandate_options?: Record; + mandate_options?: { + reference_prefix?: string | ""; + }; }; /** setup_intent_param */ card?: { @@ -55961,6 +56469,7 @@ export interface operations { amount: number; /** @enum {string} */ amount_type: "fixed" | "maximum"; + /** Format: currency */ currency: string; description?: string; /** Format: unix-time */ @@ -56011,7 +56520,9 @@ export interface operations { /** setup_intent_payment_method_options_param */ sepa_debit?: { /** payment_method_options_mandate_options_param */ - mandate_options?: Record; + mandate_options?: { + reference_prefix?: string | ""; + }; }; /** setup_intent_payment_method_options_param */ us_bank_account?: { @@ -56048,6 +56559,7 @@ export interface operations { */ single_use?: { amount: number; + /** Format: currency */ currency: string; }; /** @@ -56349,7 +56861,9 @@ export interface operations { /** setup_intent_payment_method_options_param */ bacs_debit?: { /** payment_method_options_mandate_options_param */ - mandate_options?: Record; + mandate_options?: { + reference_prefix?: string | ""; + }; }; /** setup_intent_param */ card?: { @@ -56358,6 +56872,7 @@ export interface operations { amount: number; /** @enum {string} */ amount_type: "fixed" | "maximum"; + /** Format: currency */ currency: string; description?: string; /** Format: unix-time */ @@ -56408,7 +56923,9 @@ export interface operations { /** setup_intent_payment_method_options_param */ sepa_debit?: { /** payment_method_options_mandate_options_param */ - mandate_options?: Record; + mandate_options?: { + reference_prefix?: string | ""; + }; }; /** setup_intent_payment_method_options_param */ us_bank_account?: { @@ -56745,7 +57262,9 @@ export interface operations { /** setup_intent_payment_method_options_param */ bacs_debit?: { /** payment_method_options_mandate_options_param */ - mandate_options?: Record; + mandate_options?: { + reference_prefix?: string | ""; + }; }; /** setup_intent_param */ card?: { @@ -56754,6 +57273,7 @@ export interface operations { amount: number; /** @enum {string} */ amount_type: "fixed" | "maximum"; + /** Format: currency */ currency: string; description?: string; /** Format: unix-time */ @@ -56804,7 +57324,9 @@ export interface operations { /** setup_intent_payment_method_options_param */ sepa_debit?: { /** payment_method_options_mandate_options_param */ - mandate_options?: Record; + mandate_options?: { + reference_prefix?: string | ""; + }; }; /** setup_intent_payment_method_options_param */ us_bank_account?: { @@ -57007,6 +57529,7 @@ export interface operations { */ fixed_amount?: { amount: number; + /** Format: currency */ currency: string; currency_options?: { [key: string]: { @@ -57259,7 +57782,10 @@ export interface operations { "application/x-www-form-urlencoded": { /** @description Amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for `single_use` sources. Not supported for `receiver` type sources, where charge amount may not be specified until funds land. */ amount?: number; - /** @description Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) associated with the source. This is the currency for which the source will be chargeable once ready. */ + /** + * Format: currency + * @description Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) associated with the source. This is the currency for which the source will be chargeable once ready. + */ currency?: string; /** @description The `Customer` to whom the original source is attached to. Must be set when the original source is not a `Source` (e.g., `Card`). */ customer?: string; @@ -57298,6 +57824,7 @@ export interface operations { user_agent?: string; }; amount?: number | ""; + /** Format: currency */ currency?: string; /** @enum {string} */ interval?: "one_time" | "scheduled" | "variable"; @@ -57349,6 +57876,7 @@ export interface operations { source_order?: { items?: { amount?: number; + /** Format: currency */ currency?: string; description?: string; parent?: string; @@ -57489,6 +58017,7 @@ export interface operations { user_agent?: string; }; amount?: number | ""; + /** Format: currency */ currency?: string; /** @enum {string} */ interval?: "one_time" | "scheduled" | "variable"; @@ -57524,6 +58053,7 @@ export interface operations { source_order?: { items?: { amount?: number; + /** Format: currency */ currency?: string; description?: string; parent?: string; @@ -57844,6 +58374,7 @@ export interface operations { * @description Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. */ price_data?: { + /** Format: currency */ currency: string; product: string; /** recurring_adhoc */ @@ -57984,6 +58515,7 @@ export interface operations { * @description Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required. */ price_data?: { + /** Format: currency */ currency: string; product: string; /** recurring_adhoc */ @@ -58350,6 +58882,7 @@ export interface operations { price?: string; /** one_time_price_data_with_negative_amounts */ price_data?: { + /** Format: currency */ currency: string; product: string; /** @enum {string} */ @@ -58381,6 +58914,7 @@ export interface operations { /** @enum {string} */ collection_method?: "charge_automatically" | "send_invoice"; coupon?: string; + /** Format: currency */ currency?: string; default_payment_method?: string; default_tax_rates?: string[] | ""; @@ -58418,6 +58952,7 @@ export interface operations { price?: string; /** recurring_price_data */ price_data?: { + /** Format: currency */ currency: string; product: string; /** recurring_adhoc */ @@ -58592,6 +59127,7 @@ export interface operations { price?: string; /** one_time_price_data_with_negative_amounts */ price_data?: { + /** Format: currency */ currency: string; product: string; /** @enum {string} */ @@ -58658,6 +59194,7 @@ export interface operations { price?: string; /** recurring_price_data */ price_data?: { + /** Format: currency */ currency: string; product: string; /** recurring_adhoc */ @@ -58910,6 +59447,7 @@ export interface operations { price?: string; /** one_time_price_data_with_negative_amounts */ price_data?: { + /** Format: currency */ currency: string; product: string; /** @enum {string} */ @@ -58976,7 +59514,10 @@ export interface operations { collection_method?: "charge_automatically" | "send_invoice"; /** @description The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription. This field has been deprecated and will be removed in a future API version. Use `discounts` instead. */ coupon?: string; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency?: string; /** @description The identifier of the customer to subscribe. */ customer: string; @@ -59027,6 +59568,7 @@ export interface operations { price?: string; /** recurring_price_data */ price_data?: { + /** Format: currency */ currency: string; product: string; /** recurring_adhoc */ @@ -59307,6 +59849,7 @@ export interface operations { price?: string; /** one_time_price_data_with_negative_amounts */ price_data?: { + /** Format: currency */ currency: string; product: string; /** @enum {string} */ @@ -59413,6 +59956,7 @@ export interface operations { price?: string; /** recurring_price_data */ price_data?: { + /** Format: currency */ currency: string; product: string; /** recurring_adhoc */ @@ -59731,7 +60275,10 @@ export interface operations { requestBody: { content: { "application/x-www-form-urlencoded": { - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description The ID of an existing customer to use for this calculation. If provided, the customer's address and tax IDs are copied to `customer_details`. */ customer?: string; @@ -59754,7 +60301,7 @@ export interface operations { ip_address?: string; tax_ids?: { /** @enum {string} */ - type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "by_tin" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "li_vat" | "ma_vat" | "md_vat" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "tz_vat" | "ua_vat" | "us_ein" | "uy_ruc" | "uz_tin" | "uz_vat" | "ve_rif" | "vn_tin" | "za_vat"; + type: "ad_nrt" | "ae_trn" | "al_tin" | "am_tin" | "ao_tin" | "ar_cuit" | "au_abn" | "au_arn" | "ba_tin" | "bb_tin" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "bs_tin" | "by_tin" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "cd_nif" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "gn_nif" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kh_tin" | "kr_brn" | "kz_bin" | "li_uid" | "li_vat" | "ma_vat" | "md_vat" | "me_pib" | "mk_vat" | "mr_nif" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "np_pan" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sn_ninea" | "sr_fin" | "sv_nit" | "th_vat" | "tj_tin" | "tr_tin" | "tw_vat" | "tz_vat" | "ua_vat" | "ug_tin" | "us_ein" | "uy_ruc" | "uz_tin" | "uz_vat" | "ve_rif" | "vn_tin" | "za_vat" | "zm_tin" | "zw_tin"; value: string; }[]; /** @enum {string} */ @@ -59997,6 +60544,21 @@ export interface operations { /** @enum {string} */ type: "standard"; }; + /** default */ + al?: { + /** @enum {string} */ + type: "standard"; + }; + /** simplified */ + am?: { + /** @enum {string} */ + type: "simplified"; + }; + /** default */ + ao?: { + /** @enum {string} */ + type: "standard"; + }; /** europe */ at?: { /** standard */ @@ -60012,6 +60574,16 @@ export interface operations { /** @enum {string} */ type: "standard"; }; + /** default */ + ba?: { + /** @enum {string} */ + type: "standard"; + }; + /** default */ + bb?: { + /** @enum {string} */ + type: "standard"; + }; /** europe */ be?: { /** standard */ @@ -60037,6 +60609,11 @@ export interface operations { /** @enum {string} */ type: "standard"; }; + /** default */ + bs?: { + /** @enum {string} */ + type: "standard"; + }; /** simplified */ by?: { /** @enum {string} */ @@ -60052,6 +60629,11 @@ export interface operations { type: "province_standard" | "simplified" | "standard"; }; /** default */ + cd?: { + /** @enum {string} */ + type: "standard"; + }; + /** default */ ch?: { /** @enum {string} */ type: "standard"; @@ -60171,6 +60753,11 @@ export interface operations { /** @enum {string} */ type: "simplified"; }; + /** default */ + gn?: { + /** @enum {string} */ + type: "standard"; + }; /** europe */ gr?: { /** standard */ @@ -60242,6 +60829,11 @@ export interface operations { type: "simplified"; }; /** simplified */ + kh?: { + /** @enum {string} */ + type: "simplified"; + }; + /** simplified */ kr?: { /** @enum {string} */ type: "simplified"; @@ -60291,6 +60883,21 @@ export interface operations { /** @enum {string} */ type: "simplified"; }; + /** default */ + me?: { + /** @enum {string} */ + type: "standard"; + }; + /** default */ + mk?: { + /** @enum {string} */ + type: "standard"; + }; + /** default */ + mr?: { + /** @enum {string} */ + type: "standard"; + }; /** europe */ mt?: { /** standard */ @@ -60331,6 +60938,11 @@ export interface operations { /** @enum {string} */ type: "standard"; }; + /** simplified */ + np?: { + /** @enum {string} */ + type: "simplified"; + }; /** default */ nz?: { /** @enum {string} */ @@ -60341,6 +60953,11 @@ export interface operations { /** @enum {string} */ type: "standard"; }; + /** simplified */ + pe?: { + /** @enum {string} */ + type: "simplified"; + }; /** europe */ pl?: { /** standard */ @@ -60422,11 +61039,26 @@ export interface operations { type: "ioss" | "oss_non_union" | "oss_union" | "standard"; }; /** simplified */ + sn?: { + /** @enum {string} */ + type: "simplified"; + }; + /** default */ + sr?: { + /** @enum {string} */ + type: "standard"; + }; + /** simplified */ th?: { /** @enum {string} */ type: "simplified"; }; /** simplified */ + tj?: { + /** @enum {string} */ + type: "simplified"; + }; + /** simplified */ tr?: { /** @enum {string} */ type: "simplified"; @@ -60436,6 +61068,11 @@ export interface operations { /** @enum {string} */ type: "simplified"; }; + /** simplified */ + ug?: { + /** @enum {string} */ + type: "simplified"; + }; /** united_states */ us?: { /** local_amusement_tax */ @@ -60458,6 +61095,11 @@ export interface operations { /** @enum {string} */ type: "local_amusement_tax" | "local_lease_tax" | "state_communications_tax" | "state_retail_delivery_fee" | "state_sales_tax"; }; + /** default */ + uy?: { + /** @enum {string} */ + type: "standard"; + }; /** simplified */ uz?: { /** @enum {string} */ @@ -60473,6 +61115,16 @@ export interface operations { /** @enum {string} */ type: "standard"; }; + /** simplified */ + zm?: { + /** @enum {string} */ + type: "simplified"; + }; + /** default */ + zw?: { + /** @enum {string} */ + type: "standard"; + }; }; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; @@ -61069,10 +61721,10 @@ export interface operations { type: "account" | "application" | "customer" | "self"; }; /** - * @description Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, or `za_vat` + * @description Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `ba_tin`, `bb_tin`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kh_tin`, `kr_brn`, `kz_bin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin` * @enum {string} */ - type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "by_tin" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "li_vat" | "ma_vat" | "md_vat" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sv_nit" | "th_vat" | "tr_tin" | "tw_vat" | "tz_vat" | "ua_vat" | "us_ein" | "uy_ruc" | "uz_tin" | "uz_vat" | "ve_rif" | "vn_tin" | "za_vat"; + type: "ad_nrt" | "ae_trn" | "al_tin" | "am_tin" | "ao_tin" | "ar_cuit" | "au_abn" | "au_arn" | "ba_tin" | "bb_tin" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "bs_tin" | "by_tin" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "cd_nif" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "gn_nif" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kh_tin" | "kr_brn" | "kz_bin" | "li_uid" | "li_vat" | "ma_vat" | "md_vat" | "me_pib" | "mk_vat" | "mr_nif" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "np_pan" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sn_ninea" | "sr_fin" | "sv_nit" | "th_vat" | "tj_tin" | "tr_tin" | "tw_vat" | "tz_vat" | "ua_vat" | "ug_tin" | "us_ein" | "uy_ruc" | "uz_tin" | "uz_vat" | "ve_rif" | "vn_tin" | "za_vat" | "zm_tin" | "zw_tin"; /** @description Value of the tax ID. */ value: string; }; @@ -62039,7 +62691,7 @@ export interface operations { "application/x-www-form-urlencoded": { /** * optional_fields_address - * @description The full address of the location. If you're updating the `address` field, avoid changing the `country`. If you need to modify the `country` field, create a new `Location` object and re-register any existing readers to that location. + * @description The full address of the location. You can't change the location's `country`. If you need to modify the `country` field, create a new `Location` object and re-register any existing readers to that location. */ address?: { city?: string; @@ -62563,6 +63215,7 @@ export interface operations { * @description Cart */ cart?: { + /** Format: currency */ currency: string; line_items: { amount: number; @@ -62845,7 +63498,10 @@ export interface operations { "application/x-www-form-urlencoded": { /** @description Amount to be used for this test cash balance transaction. A positive integer representing how much to fund in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to fund $1.00 or 100 to fund ¥100, a zero-decimal currency). */ amount: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; @@ -62902,7 +63558,10 @@ export interface operations { authorization_method?: "chip" | "contactless" | "keyed_in" | "online" | "swipe"; /** @description Card associated with this authorization. */ card: string; - /** @description The currency of the authorization. If not provided, defaults to the currency of the card. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description The currency of the authorization. If not provided, defaults to the currency of the card. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency?: string; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; @@ -62963,7 +63622,10 @@ export interface operations { is_amount_controllable?: boolean; /** @description The total amount to attempt to authorize. This amount is in the provided merchant currency, and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ merchant_amount?: number; - /** @description The currency of the authorization. If not provided, defaults to the currency of the card. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description The currency of the authorization. If not provided, defaults to the currency of the card. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ merchant_currency?: string; /** * merchant_data_specs @@ -63747,7 +64409,10 @@ export interface operations { bin: string; /** @description The date that the transactions are cleared and posted to user's accounts. */ clearing_date: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; @@ -63799,7 +64464,10 @@ export interface operations { amount: number; /** @description Card associated with this transaction. */ card: string; - /** @description The currency of the capture. If not provided, defaults to the currency of the card. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description The currency of the capture. If not provided, defaults to the currency of the card. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency?: string; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; @@ -63940,7 +64608,10 @@ export interface operations { amount: number; /** @description Card associated with this unlinked refund transaction. */ card: string; - /** @description The currency of the unlinked refund. If not provided, defaults to the currency of the card. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description The currency of the unlinked refund. If not provided, defaults to the currency of the card. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency?: string; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; @@ -64906,7 +65577,10 @@ export interface operations { "application/x-www-form-urlencoded": { /** @description Amount (in cents) to be transferred. */ amount: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ description?: string; @@ -64969,7 +65643,10 @@ export interface operations { "application/x-www-form-urlencoded": { /** @description Amount (in cents) to be transferred. */ amount: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ description?: string; @@ -65200,6 +65877,7 @@ export interface operations { /** @enum {string} */ account_type?: "checking" | "futsu" | "savings" | "toza"; country: string; + /** Format: currency */ currency?: string; payment_method?: string; routing_number?: string; @@ -65328,6 +66006,7 @@ export interface operations { }; /** relationship_specs */ relationship?: { + authorizer?: boolean; director?: boolean; executive?: boolean; legal_guardian?: boolean; @@ -65738,7 +66417,10 @@ export interface operations { "application/x-www-form-urlencoded": { /** @description A positive integer in cents (or local equivalent) representing how much to transfer. */ amount?: number; - /** @description Three-letter [ISO code for currency](https://www.iso.org/iso-4217-currency-codes.html) in lowercase. Must be a [supported currency](https://docs.stripe.com/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO code for currency](https://www.iso.org/iso-4217-currency-codes.html) in lowercase. Must be a [supported currency](https://docs.stripe.com/currencies). + */ currency: string; /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ description?: string; @@ -66858,7 +67540,10 @@ export interface operations { "application/x-www-form-urlencoded": { /** @description Amount (in cents) to be transferred. */ amount: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ description?: string; @@ -67053,7 +67738,10 @@ export interface operations { "application/x-www-form-urlencoded": { /** @description Amount (in cents) to be transferred. */ amount: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description ID of the customer to whom the OutboundPayment is sent. Must match the Customer attached to the `destination_payment_method` passed in. */ customer?: string; @@ -67295,7 +67983,10 @@ export interface operations { "application/x-www-form-urlencoded": { /** @description Amount (in cents) to be transferred. */ amount: number; - /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /** + * Format: currency + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ currency: string; /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ description?: string; @@ -67910,7 +68601,7 @@ export interface operations { * @description Events sent to this endpoint will be generated with this Stripe Version instead of your account's default Stripe Version. * @enum {string} */ - api_version?: "2011-01-01" | "2011-06-21" | "2011-06-28" | "2011-08-01" | "2011-09-15" | "2011-11-17" | "2012-02-23" | "2012-03-25" | "2012-06-18" | "2012-06-28" | "2012-07-09" | "2012-09-24" | "2012-10-26" | "2012-11-07" | "2013-02-11" | "2013-02-13" | "2013-07-05" | "2013-08-12" | "2013-08-13" | "2013-10-29" | "2013-12-03" | "2014-01-31" | "2014-03-13" | "2014-03-28" | "2014-05-19" | "2014-06-13" | "2014-06-17" | "2014-07-22" | "2014-07-26" | "2014-08-04" | "2014-08-20" | "2014-09-08" | "2014-10-07" | "2014-11-05" | "2014-11-20" | "2014-12-08" | "2014-12-17" | "2014-12-22" | "2015-01-11" | "2015-01-26" | "2015-02-10" | "2015-02-16" | "2015-02-18" | "2015-03-24" | "2015-04-07" | "2015-06-15" | "2015-07-07" | "2015-07-13" | "2015-07-28" | "2015-08-07" | "2015-08-19" | "2015-09-03" | "2015-09-08" | "2015-09-23" | "2015-10-01" | "2015-10-12" | "2015-10-16" | "2016-02-03" | "2016-02-19" | "2016-02-22" | "2016-02-23" | "2016-02-29" | "2016-03-07" | "2016-06-15" | "2016-07-06" | "2016-10-19" | "2017-01-27" | "2017-02-14" | "2017-04-06" | "2017-05-25" | "2017-06-05" | "2017-08-15" | "2017-12-14" | "2018-01-23" | "2018-02-05" | "2018-02-06" | "2018-02-28" | "2018-05-21" | "2018-07-27" | "2018-08-23" | "2018-09-06" | "2018-09-24" | "2018-10-31" | "2018-11-08" | "2019-02-11" | "2019-02-19" | "2019-03-14" | "2019-05-16" | "2019-08-14" | "2019-09-09" | "2019-10-08" | "2019-10-17" | "2019-11-05" | "2019-12-03" | "2020-03-02" | "2020-08-27" | "2022-08-01" | "2022-11-15" | "2023-08-16" | "2023-10-16" | "2024-04-10" | "2024-06-20" | "2024-09-30.acacia" | "2024-10-28.acacia"; + api_version?: "2011-01-01" | "2011-06-21" | "2011-06-28" | "2011-08-01" | "2011-09-15" | "2011-11-17" | "2012-02-23" | "2012-03-25" | "2012-06-18" | "2012-06-28" | "2012-07-09" | "2012-09-24" | "2012-10-26" | "2012-11-07" | "2013-02-11" | "2013-02-13" | "2013-07-05" | "2013-08-12" | "2013-08-13" | "2013-10-29" | "2013-12-03" | "2014-01-31" | "2014-03-13" | "2014-03-28" | "2014-05-19" | "2014-06-13" | "2014-06-17" | "2014-07-22" | "2014-07-26" | "2014-08-04" | "2014-08-20" | "2014-09-08" | "2014-10-07" | "2014-11-05" | "2014-11-20" | "2014-12-08" | "2014-12-17" | "2014-12-22" | "2015-01-11" | "2015-01-26" | "2015-02-10" | "2015-02-16" | "2015-02-18" | "2015-03-24" | "2015-04-07" | "2015-06-15" | "2015-07-07" | "2015-07-13" | "2015-07-28" | "2015-08-07" | "2015-08-19" | "2015-09-03" | "2015-09-08" | "2015-09-23" | "2015-10-01" | "2015-10-12" | "2015-10-16" | "2016-02-03" | "2016-02-19" | "2016-02-22" | "2016-02-23" | "2016-02-29" | "2016-03-07" | "2016-06-15" | "2016-07-06" | "2016-10-19" | "2017-01-27" | "2017-02-14" | "2017-04-06" | "2017-05-25" | "2017-06-05" | "2017-08-15" | "2017-12-14" | "2018-01-23" | "2018-02-05" | "2018-02-06" | "2018-02-28" | "2018-05-21" | "2018-07-27" | "2018-08-23" | "2018-09-06" | "2018-09-24" | "2018-10-31" | "2018-11-08" | "2019-02-11" | "2019-02-19" | "2019-03-14" | "2019-05-16" | "2019-08-14" | "2019-09-09" | "2019-10-08" | "2019-10-17" | "2019-11-05" | "2019-12-03" | "2020-03-02" | "2020-08-27" | "2022-08-01" | "2022-11-15" | "2023-08-16" | "2023-10-16" | "2024-04-10" | "2024-06-20" | "2024-09-30.acacia" | "2024-10-28.acacia" | "2024-11-20.acacia" | "2024-12-18.acacia"; /** @description Whether this endpoint should receive events from connected accounts (`true`), or from your account (`false`). Defaults to `false`. */ connect?: boolean; /** @description An optional description of what the webhook is used for. */ diff --git a/packages/openapi-typescript/examples/stripe-api.yaml b/packages/openapi-typescript/examples/stripe-api.yaml index d86320dd5..d0a501f06 100644 --- a/packages/openapi-typescript/examples/stripe-api.yaml +++ b/packages/openapi-typescript/examples/stripe-api.yaml @@ -221,6 +221,7 @@ components: code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + format: currency nullable: true type: string fiscal_year_end: @@ -887,12 +888,11 @@ components: type: array current_deadline: description: >- - Date on which `future_requirements` merges with the main - `requirements` hash and `future_requirements` becomes empty. After - the transition, `currently_due` requirements may immediately become - `past_due`, but the account may also be given a grace period - depending on the capability's enablement state prior to - transitioning. + Date on which `future_requirements` becomes the main `requirements` + hash and `future_requirements` becomes empty. After the transition, + `currently_due` requirements may immediately become `past_due`, but + the account may also be given a grace period depending on the + capability's enablement state prior to transitioning. format: unix-time nullable: true type: integer @@ -933,9 +933,8 @@ components: type: array eventually_due: description: >- - Fields that need to be collected assuming all volume thresholds are - reached. As they become required, they appear in `currently_due` as - well. + Fields you must collect when all thresholds are reached. As they + become required, they appear in `currently_due` as well. items: maxLength: 5000 type: string @@ -1030,9 +1029,9 @@ components: type: array eventually_due: description: >- - Fields that need to be collected assuming all volume thresholds are - reached. As they become required, they appear in `currently_due` as - well, and `current_deadline` becomes set. + Fields you must collect when all thresholds are reached. As they + become required, they appear in `currently_due` as well, and + `current_deadline` becomes set. items: maxLength: 5000 type: string @@ -1172,11 +1171,11 @@ components: type: array current_deadline: description: >- - Date on which `future_requirements` merges with the main - `requirements` hash and `future_requirements` becomes empty. After - the transition, `currently_due` requirements may immediately become - `past_due`, but the account may also be given a grace period - depending on its enablement state prior to transitioning. + Date on which `future_requirements` becomes the main `requirements` + hash and `future_requirements` becomes empty. After the transition, + `currently_due` requirements may immediately become `past_due`, but + the account may also be given a grace period depending on its + enablement state prior to transitioning. format: unix-time nullable: true type: integer @@ -1222,9 +1221,8 @@ components: type: array eventually_due: description: >- - Fields that need to be collected assuming all volume thresholds are - reached. As they become required, they appear in `currently_due` as - well. + Fields you must collect when all thresholds are reached. As they + become required, they appear in `currently_due` as well. items: maxLength: 5000 type: string @@ -1352,6 +1350,7 @@ components: code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + format: currency type: string required: - amount @@ -1496,9 +1495,9 @@ components: type: array eventually_due: description: >- - Fields that need to be collected assuming all volume thresholds are - reached. As they become required, they appear in `currently_due` as - well, and `current_deadline` becomes set. + Fields you must collect when all thresholds are reached. As they + become required, they appear in `currently_due` as well, and + `current_deadline` becomes set. items: maxLength: 5000 type: string @@ -1995,6 +1994,21 @@ components: title: Address type: object x-expandableFields: [] + amazon_pay_underlying_payment_method_funding_details: + description: '' + properties: + card: + $ref: '#/components/schemas/payment_method_details_passthrough_card' + type: + description: funding type of the underlying payment method. + enum: + - card + nullable: true + type: string + title: amazon_pay_underlying_payment_method_funding_details + type: object + x-expandableFields: + - card api_errors: description: '' properties: @@ -2029,6 +2043,20 @@ components: card errors, these messages can be shown to your users. maxLength: 40000 type: string + network_advice_code: + description: >- + For card errors resulting from a card issuer decline, a 2 digit code + which indicates the advice given to merchant by the card network on + how to proceed with an error. + maxLength: 5000 + type: string + network_decline_code: + description: >- + For card errors resulting from a card issuer decline, a brand + specific 2, 3, or 4 digit code which indicates the reason the + authorization failed. + maxLength: 5000 + type: string param: description: >- If the error is parameter-specific, the parameter related to the @@ -2206,6 +2234,7 @@ components: code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + format: currency type: string fee_source: anyOf: @@ -2386,6 +2415,13 @@ components: automatic_tax: description: '' properties: + disabled_reason: + description: 'If Stripe disabled automatic tax, this enum describes why.' + enum: + - finalization_requires_location_inputs + - finalization_system_error + nullable: true + type: string enabled: description: >- Whether Stripe automatically computes tax on this invoice. Note that @@ -2518,6 +2554,7 @@ components: code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + format: currency type: string source_types: $ref: '#/components/schemas/balance_amount_by_source_type' @@ -2555,6 +2592,7 @@ components: code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + format: currency type: string net_available: description: Breakdown of balance by destination. @@ -2639,6 +2677,7 @@ components: code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + format: currency type: string description: description: >- @@ -2756,8 +2795,9 @@ components: `obligation_reversal_inbound`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, - `payout`, `payout_cancel`, `payout_failure`, `refund`, - `refund_failure`, `reserve_transaction`, `reserved_funds`, + `payout`, `payout_cancel`, `payout_failure`, + `payout_minimum_balance_hold`, `payout_minimum_balance_release`, + `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`. Learn more about [balance transaction types and @@ -2793,6 +2833,8 @@ components: - payout - payout_cancel - payout_failure + - payout_minimum_balance_hold + - payout_minimum_balance_release - refund - refund_failure - reserve_transaction @@ -2902,6 +2944,7 @@ components: Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account. + format: currency type: string customer: anyOf: @@ -3529,7 +3572,7 @@ components: - $ref: '#/components/schemas/deleted_customer' effective_at: description: >- - The time when the billing credits become effective—when they're + The time when the billing credits become effective-when they're eligible for use. format: unix-time nullable: true @@ -3615,11 +3658,9 @@ components: x-resourceId: billing.credit_grant billing.meter: description: >- - A billing meter is a resource that allows you to track usage of a - particular event. For example, you might create a billing meter to track - the number of API calls made by a particular user. You can then attach - the billing meter to a price and attach the price to a subscription to - charge the user for the number of API calls they make. + Meters specify how to aggregate meter events over a billing period. + Meter events represent the actions that customers take in your system. + Meters attach to prices and form the basis of the bill. Related guide: [Usage based @@ -3709,11 +3750,10 @@ components: x-resourceId: billing.meter billing.meter_event: description: >- - A billing meter event represents a customer's usage of a product. Meter - events are used to bill a customer based on their usage. - - Meter events are associated with billing meters, which define the shape - of the event's payload and how those events are aggregated for billing. + Meter events represent actions that customers take in your system. You + can use meter events to bill a customer based on their usage. Meter + events are associated with billing meters, which define both the + contents of the event’s payload and how to aggregate those events. properties: created: description: >- @@ -3945,9 +3985,19 @@ components: properties: amount: $ref: '#/components/schemas/billing_credit_grants_resource_amount' + credits_application_invoice_voided: + anyOf: + - $ref: >- + #/components/schemas/billing_credit_grants_resource_balance_credits_application_invoice_voided + description: >- + Details of the invoice to which the reinstated credits were + originally applied. Only present if `type` is + `credits_application_invoice_voided`. + nullable: true type: description: The type of credit transaction. enum: + - credits_application_invoice_voided - credits_granted type: string required: @@ -3957,6 +4007,34 @@ components: type: object x-expandableFields: - amount + - credits_application_invoice_voided + billing_credit_grants_resource_balance_credits_application_invoice_voided: + description: '' + properties: + invoice: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/invoice' + description: >- + The invoice to which the reinstated billing credits were originally + applied. + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/invoice' + invoice_line_item: + description: >- + The invoice line item to which the reinstated billing credits were + originally applied. + maxLength: 5000 + type: string + required: + - invoice + - invoice_line_item + title: BillingCreditGrantsResourceBalanceCreditsApplicationInvoiceVoided + type: object + x-expandableFields: + - invoice billing_credit_grants_resource_balance_credits_applied: description: '' properties: @@ -4033,7 +4111,7 @@ components: properties: price_type: description: >- - The price type for which credit grants can apply. We currently only + The price type that credit grants can apply to. We currently only support the `metered` price type. This refers to prices that have a [Billing Meter](https://docs.stripe.com/api/billing/meter) attached to them. @@ -4589,6 +4667,19 @@ components: maxLength: 5000 nullable: true type: string + allow_redisplay: + description: >- + This field indicates whether this payment method can be shown again + to its customer in a checkout flow. Stripe products such as Checkout + and Elements use this field to determine whether a payment method + can be shown as a saved payment method in a checkout flow. The field + defaults to “unspecified”. + enum: + - always + - limited + - unspecified + nullable: true + type: string available_payout_methods: description: >- A set of available payout methods for this card. Only values from @@ -4626,6 +4717,7 @@ components: only available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. + format: currency nullable: true type: string customer: @@ -4702,6 +4794,10 @@ components: description: Unique identifier for the object. maxLength: 5000 type: string + iin: + description: Issuer identification number of the card. + maxLength: 5000 + type: string last4: description: The last four digits of the card. maxLength: 5000 @@ -4730,6 +4826,13 @@ components: enum: - card type: string + regulated_status: + description: Status of a card based on the card issuer. + enum: + - regulated + - unregulated + nullable: true + type: string status: description: >- For external accounts that are cards, possible values are `new` and @@ -4962,6 +5065,7 @@ components: code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + format: currency type: string customer: anyOf: @@ -5315,6 +5419,20 @@ components: charge_outcome: description: '' properties: + network_advice_code: + description: >- + For charges declined by the network, a 2 digit code which indicates + the advice returned by the network on how to proceed with an error. + maxLength: 5000 + nullable: true + type: string + network_decline_code: + description: >- + For charges declined by the network, a brand specific 2, 3, or 4 + digit code which indicates the reason the authorization failed. + maxLength: 5000 + nullable: true + type: string network_status: description: >- Possible values are `approved_by_network`, `declined_by_network`, @@ -5535,6 +5653,7 @@ components: code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + format: currency nullable: true type: string currency_conversion: @@ -7165,13 +7284,29 @@ components: x-expandableFields: [] checkout_payment_method_options_mandate_options_bacs_debit: description: '' - properties: {} + properties: + reference_prefix: + description: >- + Prefix used to generate the Mandate reference. Must be at most 12 + characters long. Must consist of only uppercase letters, numbers, + spaces, or the following special characters: '/', '_', '-', '&', + '.'. Cannot begin with 'DDIC' or 'STRIPE'. + maxLength: 5000 + type: string title: checkout_payment_method_options_mandate_options_bacs_debit type: object x-expandableFields: [] checkout_payment_method_options_mandate_options_sepa_debit: description: '' - properties: {} + properties: + reference_prefix: + description: >- + Prefix used to generate the Mandate reference. Must be at most 12 + characters long. Must consist of only uppercase letters, numbers, + spaces, or the following special characters: '/', '_', '-', '&', + '.'. Cannot begin with 'STRIPE'. + maxLength: 5000 + type: string title: checkout_payment_method_options_mandate_options_sepa_debit type: object x-expandableFields: [] @@ -8456,6 +8591,7 @@ components: code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + format: currency type: string destination: anyOf: @@ -8514,11 +8650,12 @@ components: disable_stripe_user_authentication: description: >- Disables Stripe user authentication for this embedded component. - This feature can only be false for accounts where you’re responsible - for collecting updated information when requirements are due or - change, like custom accounts. The default value for this feature is - `false` when `external_account_collection` is enabled and `true` - otherwise. + This value can only be true for accounts where + `controller.requirement_collection` is `application`. The default + value is the opposite of the `external_account_collection` value. + For example, if you don’t set `external_account_collection`, it + defaults to true and `disable_stripe_user_authentication` defaults + to false. type: boolean external_account_collection: description: >- @@ -8672,11 +8809,12 @@ components: disable_stripe_user_authentication: description: >- Disables Stripe user authentication for this embedded component. - This feature can only be false for accounts where you’re responsible - for collecting updated information when requirements are due or - change, like custom accounts. The default value for this feature is - `false` when `external_account_collection` is enabled and `true` - otherwise. + This value can only be true for accounts where + `controller.requirement_collection` is `application`. The default + value is the opposite of the `external_account_collection` value. + For example, if you don’t set `external_account_collection`, it + defaults to true and `disable_stripe_user_authentication` defaults + to false. type: boolean edit_payout_schedule: description: >- @@ -8866,6 +9004,7 @@ components: If `amount_off` has been set, the three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the amount to take off. + format: currency nullable: true type: string currency_options: @@ -9038,6 +9177,7 @@ components: code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + format: currency type: string customer: anyOf: @@ -10274,6 +10414,7 @@ components: code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + format: currency type: string customer: anyOf: @@ -11776,6 +11917,7 @@ components: code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + format: currency type: string enhanced_eligibility_types: description: List of eligibility types that are included in `enhanced_evidence`. @@ -11890,10 +12032,13 @@ components: visa_compelling_evidence_3: $ref: >- #/components/schemas/dispute_enhanced_eligibility_visa_compelling_evidence3 + visa_compliance: + $ref: '#/components/schemas/dispute_enhanced_eligibility_visa_compliance' title: DisputeEnhancedEligibility type: object x-expandableFields: - visa_compelling_evidence_3 + - visa_compliance dispute_enhanced_eligibility_visa_compelling_evidence3: description: '' properties: @@ -11923,16 +12068,33 @@ components: title: DisputeEnhancedEligibilityVisaCompellingEvidence3 type: object x-expandableFields: [] + dispute_enhanced_eligibility_visa_compliance: + description: '' + properties: + status: + description: Visa compliance eligibility status. + enum: + - fee_acknowledged + - requires_fee_acknowledgement + type: string + required: + - status + title: DisputeEnhancedEligibilityVisaCompliance + type: object + x-expandableFields: [] dispute_enhanced_evidence: description: '' properties: visa_compelling_evidence_3: $ref: >- #/components/schemas/dispute_enhanced_evidence_visa_compelling_evidence3 + visa_compliance: + $ref: '#/components/schemas/dispute_enhanced_evidence_visa_compliance' title: DisputeEnhancedEvidence type: object x-expandableFields: - visa_compelling_evidence_3 + - visa_compliance dispute_enhanced_evidence_visa_compelling_evidence3: description: '' properties: @@ -11959,6 +12121,23 @@ components: x-expandableFields: - disputed_transaction - prior_undisputed_transactions + dispute_enhanced_evidence_visa_compliance: + description: '' + properties: + fee_acknowledged: + description: >- + A field acknowledging the fee incurred when countering a Visa + compliance dispute. If this field is set to true, evidence can be + submitted for the compliance dispute. Stripe collects a 500 USD (or + local equivalent) amount to cover the network costs associated with + resolving compliance disputes. Stripe refunds the 500 USD network + fee if you win the dispute. + type: boolean + required: + - fee_acknowledged + title: DisputeEnhancedEvidenceVisaCompliance + type: object + x-expandableFields: [] dispute_evidence: description: '' properties: @@ -12987,6 +13166,7 @@ components: code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + format: currency type: string description: description: >- @@ -13049,6 +13229,7 @@ components: code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + format: currency type: string fee: anyOf: @@ -13805,6 +13986,7 @@ components: type: string currency: description: Currency of objects to be included in the report run. + format: currency type: string interval_end: description: >- @@ -14012,6 +14194,7 @@ components: - card_expiry - card_number - cardholder_name + - request_signature type: string type: array request_context: @@ -14240,10 +14423,14 @@ components: funding_instructions_bank_transfer_iban_record: description: Iban Records contain E.U. bank account details per the SEPA format. properties: + account_holder_address: + $ref: '#/components/schemas/address' account_holder_name: description: The name of the person or business that owns the bank account maxLength: 5000 type: string + bank_address: + $ref: '#/components/schemas/address' bic: description: The BIC/SWIFT code of the account. maxLength: 5000 @@ -14259,18 +14446,24 @@ components: maxLength: 5000 type: string required: + - account_holder_address - account_holder_name + - bank_address - bic - country - iban title: FundingInstructionsBankTransferIbanRecord type: object - x-expandableFields: [] + x-expandableFields: + - account_holder_address + - bank_address funding_instructions_bank_transfer_sort_code_record: description: >- Sort Code Records contain U.K. bank account details per the sort code format. properties: + account_holder_address: + $ref: '#/components/schemas/address' account_holder_name: description: The name of the person or business that owns the bank account maxLength: 5000 @@ -14279,20 +14472,34 @@ components: description: The account number maxLength: 5000 type: string + bank_address: + $ref: '#/components/schemas/address' sort_code: description: The six-digit sort code maxLength: 5000 type: string required: + - account_holder_address - account_holder_name - account_number + - bank_address - sort_code title: FundingInstructionsBankTransferSortCodeRecord type: object - x-expandableFields: [] + x-expandableFields: + - account_holder_address + - bank_address funding_instructions_bank_transfer_spei_record: description: SPEI Records contain Mexico bank account details per the SPEI format. properties: + account_holder_address: + $ref: '#/components/schemas/address' + account_holder_name: + description: The account holder name + maxLength: 5000 + type: string + bank_address: + $ref: '#/components/schemas/address' bank_code: description: The three-digit bank code maxLength: 5000 @@ -14306,12 +14513,17 @@ components: maxLength: 5000 type: string required: + - account_holder_address + - account_holder_name + - bank_address - bank_code - bank_name - clabe title: FundingInstructionsBankTransferSpeiRecord type: object - x-expandableFields: [] + x-expandableFields: + - account_holder_address + - bank_address funding_instructions_bank_transfer_swift_record: description: SWIFT Records contain U.S. bank account details per the SWIFT format. properties: @@ -14355,6 +14567,8 @@ components: funding_instructions_bank_transfer_zengin_record: description: Zengin Records contain Japan bank account details per the Zengin format. properties: + account_holder_address: + $ref: '#/components/schemas/address' account_holder_name: description: The account holder name maxLength: 5000 @@ -14370,6 +14584,8 @@ components: maxLength: 5000 nullable: true type: string + bank_address: + $ref: '#/components/schemas/address' bank_code: description: The bank code of the account maxLength: 5000 @@ -14390,9 +14606,14 @@ components: maxLength: 5000 nullable: true type: string + required: + - account_holder_address + - bank_address title: FundingInstructionsBankTransferZenginRecord type: object - x-expandableFields: [] + x-expandableFields: + - account_holder_address + - bank_address gelato_data_document_report_date_of_birth: description: Point in Time properties: @@ -15713,6 +15934,7 @@ components: code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + format: currency type: string custom_fields: description: Custom fields displayed on the invoice. @@ -17024,6 +17246,7 @@ components: code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + format: currency type: string customer: anyOf: @@ -17405,20 +17628,30 @@ components: `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, - `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, - `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, - `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, or `unknown` + `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, + `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, + `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, + `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, + `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, + `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, or + `unknown` enum: - ad_nrt - ae_trn + - al_tin + - am_tin + - ao_tin - ar_cuit - au_abn - au_arn + - ba_tin + - bb_tin - bg_uic - bh_vat - bo_tin - br_cnpj - br_cpf + - bs_tin - by_tin - ca_bn - ca_gst_hst @@ -17426,6 +17659,7 @@ components: - ca_pst_mb - ca_pst_sk - ca_qst + - cd_nif - ch_uid - ch_vat - cl_tin @@ -17441,6 +17675,7 @@ components: - eu_vat - gb_vat - ge_vat + - gn_nif - hk_br - hr_oib - hu_tin @@ -17452,12 +17687,16 @@ components: - jp_rn - jp_trn - ke_pin + - kh_tin - kr_brn - kz_bin - li_uid - li_vat - ma_vat - md_vat + - me_pib + - mk_vat + - mr_nif - mx_rfc - my_frp - my_itn @@ -17465,6 +17704,7 @@ components: - ng_tin - no_vat - no_voec + - np_pan - nz_gst - om_vat - pe_ruc @@ -17477,12 +17717,16 @@ components: - sg_gst - sg_uen - si_tin + - sn_ninea + - sr_fin - sv_nit - th_vat + - tj_tin - tr_tin - tw_vat - tz_vat - ua_vat + - ug_tin - unknown - us_ein - uy_ruc @@ -17491,6 +17735,8 @@ components: - ve_rif - vn_tin - za_vat + - zm_tin + - zw_tin type: string value: description: The value of the tax ID. @@ -17719,6 +17965,7 @@ components: code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + format: currency type: string fleet: anyOf: @@ -17767,6 +18014,7 @@ components: code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + format: currency type: string merchant_data: $ref: '#/components/schemas/issuing_authorization_merchant_data' @@ -17936,6 +18184,7 @@ components: code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Supported currencies are `usd` in the US, `eur` in the EU, and `gbp` in the UK. + format: currency type: string cvc: description: >- @@ -18262,6 +18511,7 @@ components: type: integer currency: description: The currency the `transaction` was made in. + format: currency type: string evidence: $ref: '#/components/schemas/issuing_dispute_evidence' @@ -18555,6 +18805,7 @@ components: code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + format: currency type: string id: description: Unique identifier for the object. @@ -18818,6 +19069,7 @@ components: code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + format: currency type: string dispute: anyOf: @@ -18848,6 +19100,7 @@ components: type: integer merchant_currency: description: The currency with which the merchant is taking payment. + format: currency type: string merchant_data: $ref: '#/components/schemas/issuing_authorization_merchant_data' @@ -19271,6 +19524,13 @@ components: maxLength: 5000 nullable: true type: string + tax_id: + description: >- + The seller's tax identification number. Currently populated for + French merchants only. + maxLength: 5000 + nullable: true + type: string terminal_id: description: An ID assigned by the seller to the location of the sale. maxLength: 5000 @@ -19342,6 +19602,7 @@ components: code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + format: currency type: string is_amount_controllable: description: >- @@ -19357,6 +19618,7 @@ components: type: integer merchant_currency: description: The local currency the merchant is requesting to authorize. + format: currency type: string network_risk_score: description: >- @@ -20291,6 +20553,7 @@ components: description: >- Currency of the amounts within `spending_limits`. Always the same as the currency of the card. + format: currency nullable: true type: string title: IssuingCardAuthorizationControls @@ -21481,6 +21744,7 @@ components: type: array spending_limits_currency: description: Currency of the amounts within `spending_limits`. + format: currency nullable: true type: string title: IssuingCardholderAuthorizationControls @@ -23217,12 +23481,14 @@ components: code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + format: currency type: string description: description: >- An arbitrary string attached to the object. Often useful for displaying to users. Defaults to product name. maxLength: 5000 + nullable: true type: string discounts: description: The discounts applied to the line item. @@ -23704,6 +23970,7 @@ components: code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + format: currency type: string description: description: >- @@ -24335,6 +24602,7 @@ components: type: integer currency: description: The currency of the payment on a single use mandate. + format: currency type: string required: - amount @@ -24462,6 +24730,7 @@ components: - financial_account - us_bank_account type: string + x-stripeBypassValidation: true us_bank_account: $ref: >- #/components/schemas/outbound_payments_payment_method_details_us_bank_account @@ -25137,6 +25406,7 @@ components: code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + format: currency type: string customer: anyOf: @@ -25673,6 +25943,7 @@ components: code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + format: currency nullable: true type: string financial_addresses: @@ -26870,13 +27141,29 @@ components: x-expandableFields: [] payment_intent_payment_method_options_mandate_options_bacs_debit: description: '' - properties: {} + properties: + reference_prefix: + description: >- + Prefix used to generate the Mandate reference. Must be at most 12 + characters long. Must consist of only uppercase letters, numbers, + spaces, or the following special characters: '/', '_', '-', '&', + '.'. Cannot begin with 'DDIC' or 'STRIPE'. + maxLength: 5000 + type: string title: payment_intent_payment_method_options_mandate_options_bacs_debit type: object x-expandableFields: [] payment_intent_payment_method_options_mandate_options_sepa_debit: description: '' - properties: {} + properties: + reference_prefix: + description: >- + Prefix used to generate the Mandate reference. Must be at most 12 + characters long. Must consist of only uppercase letters, numbers, + spaces, or the following special characters: '/', '_', '-', '&', + '.'. Cannot begin with 'STRIPE'. + maxLength: 5000 + type: string title: payment_intent_payment_method_options_mandate_options_sepa_debit type: object x-expandableFields: [] @@ -26963,9 +27250,7 @@ components: description: '' properties: reference: - description: >- - The order ID displayed in the Swish app after the payment is - authorized. + description: A reference for this payment to be displayed in the Swish app. maxLength: 35 nullable: true type: string @@ -27243,6 +27528,7 @@ components: code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + format: currency type: string custom_fields: description: >- @@ -28246,6 +28532,7 @@ components: - ZW - ZZ type: string + x-stripeBypassValidation: true type: array required: - allowed_countries @@ -28856,6 +29143,13 @@ components: Contains information about card networks that can be used to process the payment. nullable: true + regulated_status: + description: Status of a card based on the card issuer. + enum: + - regulated + - unregulated + nullable: true + type: string three_d_secure_usage: anyOf: - $ref: '#/components/schemas/three_d_secure_usage' @@ -29906,10 +30200,14 @@ components: x-expandableFields: [] payment_method_details_amazon_pay: description: '' - properties: {} + properties: + funding: + $ref: >- + #/components/schemas/amazon_pay_underlying_payment_method_funding_details title: payment_method_details_amazon_pay type: object - x-expandableFields: [] + x-expandableFields: + - funding payment_method_details_au_becs_debit: description: '' properties: @@ -30179,9 +30477,29 @@ components: If this card has network token credentials, this contains the details of the network token credentials. nullable: true + network_transaction_id: + description: >- + This is used by the financial networks to identify a transaction. + Visa calls this the Transaction ID, Mastercard calls this the Trace + ID, and American Express calls this the Acquirer Reference Data. The + first three digits of the Trace ID is the Financial Network Code, + the next 6 digits is the Banknet Reference Number, and the last 4 + digits represent the date (MM/DD). This field will be available for + successful Visa, Mastercard, or American Express transactions and + always null for other card brands. + maxLength: 5000 + nullable: true + type: string overcapture: $ref: >- #/components/schemas/payment_flows_private_payment_methods_card_details_api_resource_enterprise_features_overcapture_overcapture + regulated_status: + description: Status of a card based on the card issuer. + enum: + - regulated + - unregulated + nullable: true + type: string three_d_secure: anyOf: - $ref: '#/components/schemas/three_d_secure_details_charge' @@ -31461,6 +31779,47 @@ components: title: payment_method_details_p24 type: object x-expandableFields: [] + payment_method_details_passthrough_card: + description: '' + properties: + brand: + description: >- + Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, + `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. + maxLength: 5000 + nullable: true + type: string + country: + description: >- + Two-letter ISO code representing the country of the card. You could + use this attribute to get a sense of the international breakdown of + cards you've collected. + maxLength: 5000 + nullable: true + type: string + exp_month: + description: Two-digit number representing the card's expiration month. + nullable: true + type: integer + exp_year: + description: Four-digit number representing the card's expiration year. + nullable: true + type: integer + funding: + description: >- + Card funding type. Can be `credit`, `debit`, `prepaid`, or + `unknown`. + maxLength: 5000 + nullable: true + type: string + last4: + description: The last four digits of the card. + maxLength: 5000 + nullable: true + type: string + title: payment_method_details_passthrough_card + type: object + x-expandableFields: [] payment_method_details_payco: description: '' properties: @@ -31553,10 +31912,14 @@ components: x-expandableFields: [] payment_method_details_revolut_pay: description: '' - properties: {} + properties: + funding: + $ref: >- + #/components/schemas/revolut_pay_underlying_payment_method_funding_details title: payment_method_details_revolut_pay type: object - x-expandableFields: [] + x-expandableFields: + - funding payment_method_details_samsung_pay: description: '' properties: @@ -34813,6 +35176,7 @@ components: - ZW - ZZ type: string + x-stripeBypassValidation: true type: array required: - allowed_countries @@ -34895,20 +35259,30 @@ components: `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, - `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, - `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, - `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, or `unknown` + `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, + `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, + `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, + `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, + `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, + `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, or + `unknown` enum: - ad_nrt - ae_trn + - al_tin + - am_tin + - ao_tin - ar_cuit - au_abn - au_arn + - ba_tin + - bb_tin - bg_uic - bh_vat - bo_tin - br_cnpj - br_cpf + - bs_tin - by_tin - ca_bn - ca_gst_hst @@ -34916,6 +35290,7 @@ components: - ca_pst_mb - ca_pst_sk - ca_qst + - cd_nif - ch_uid - ch_vat - cl_tin @@ -34931,6 +35306,7 @@ components: - eu_vat - gb_vat - ge_vat + - gn_nif - hk_br - hr_oib - hu_tin @@ -34942,12 +35318,16 @@ components: - jp_rn - jp_trn - ke_pin + - kh_tin - kr_brn - kz_bin - li_uid - li_vat - ma_vat - md_vat + - me_pib + - mk_vat + - mr_nif - mx_rfc - my_frp - my_itn @@ -34955,6 +35335,7 @@ components: - ng_tin - no_vat - no_voec + - np_pan - nz_gst - om_vat - pe_ruc @@ -34967,12 +35348,16 @@ components: - sg_gst - sg_uen - si_tin + - sn_ninea + - sr_fin - sv_nit - th_vat + - tj_tin - tr_tin - tw_vat - tz_vat - ua_vat + - ug_tin - unknown - us_ein - uy_ruc @@ -34981,6 +35366,8 @@ components: - ve_rif - vn_tin - za_vat + - zm_tin + - zw_tin type: string value: description: The value of the tax ID. @@ -35146,6 +35533,7 @@ components: code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + format: currency type: string description: description: >- @@ -35657,10 +36045,9 @@ components: type: array eventually_due: description: >- - Fields that need to be collected assuming all volume thresholds are - reached. As they become required, they appear in `currently_due` as - well, and the account's `future_requirements[current_deadline]` - becomes set. + Fields you must collect when all thresholds are reached. As they + become required, they appear in `currently_due` as well, and the + account's `future_requirements[current_deadline]` becomes set. items: maxLength: 5000 type: string @@ -35702,6 +36089,12 @@ components: person_relationship: description: '' properties: + authorizer: + description: >- + Whether the person is the authorizer of the account's + representative. + nullable: true + type: boolean director: description: >- Whether the person is a director of the account's legal entity. @@ -35777,9 +36170,9 @@ components: type: array eventually_due: description: >- - Fields that need to be collected assuming all volume thresholds are - reached. As they become required, they appear in `currently_due` as - well, and the account's `current_deadline` becomes set. + Fields you must collect when all thresholds are reached. As they + become required, they appear in `currently_due` as well, and the + account's `current_deadline` becomes set. items: maxLength: 5000 type: string @@ -35901,6 +36294,7 @@ components: code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + format: currency type: string id: description: Unique identifier for the object. @@ -36569,6 +36963,7 @@ components: - default_allowed_updates - enabled - proration_behavior + - schedule_at_period_end title: PortalSubscriptionUpdate type: object x-expandableFields: @@ -36646,6 +37041,7 @@ components: code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + format: currency type: string currency_options: additionalProperties: @@ -38294,6 +38690,7 @@ components: code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + format: currency type: string description: description: >- @@ -39017,6 +39414,7 @@ components: code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + format: currency type: string description: description: >- @@ -39166,6 +39564,21 @@ components: - payment_intent - session x-resourceId: review + revolut_pay_underlying_payment_method_funding_details: + description: '' + properties: + card: + $ref: '#/components/schemas/payment_method_details_passthrough_card' + type: + description: funding type of the underlying payment method. + enum: + - card + nullable: true + type: string + title: revolut_pay_underlying_payment_method_funding_details + type: object + x-expandableFields: + - card rule: description: '' properties: @@ -39275,6 +39688,12 @@ components: schedules_phase_automatic_tax: description: '' properties: + disabled_reason: + description: 'If Stripe disabled automatic tax, this enum describes why.' + enum: + - requires_location_inputs + nullable: true + type: string enabled: description: >- Whether Stripe automatically computes tax on invoices created during @@ -40667,6 +41086,7 @@ components: code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + format: currency type: string description: description: >- @@ -40789,13 +41209,29 @@ components: x-expandableFields: [] setup_intent_payment_method_options_mandate_options_bacs_debit: description: '' - properties: {} + properties: + reference_prefix: + description: >- + Prefix used to generate the Mandate reference. Must be at most 12 + characters long. Must consist of only uppercase letters, numbers, + spaces, or the following special characters: '/', '_', '-', '&', + '.'. Cannot begin with 'DDIC' or 'STRIPE'. + maxLength: 5000 + type: string title: setup_intent_payment_method_options_mandate_options_bacs_debit type: object x-expandableFields: [] setup_intent_payment_method_options_mandate_options_sepa_debit: description: '' - properties: {} + properties: + reference_prefix: + description: >- + Prefix used to generate the Mandate reference. Must be at most 12 + characters long. Must consist of only uppercase letters, numbers, + spaces, or the following special characters: '/', '_', '-', '&', + '.'. Cannot begin with 'STRIPE'. + maxLength: 5000 + type: string title: setup_intent_payment_method_options_mandate_options_sepa_debit type: object x-expandableFields: [] @@ -41071,6 +41507,7 @@ components: code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + format: currency type: string currency_options: additionalProperties: @@ -41134,6 +41571,19 @@ components: $ref: '#/components/schemas/source_type_acss_debit' alipay: $ref: '#/components/schemas/source_type_alipay' + allow_redisplay: + description: >- + This field indicates whether this payment method can be shown again + to its customer in a checkout flow. Stripe products such as Checkout + and Elements use this field to determine whether a payment method + can be shown as a saved payment method in a checkout flow. The field + defaults to “unspecified”. + enum: + - always + - limited + - unspecified + nullable: true + type: string amount: description: >- A positive integer in the smallest currency unit (that is, 100 cents @@ -41171,6 +41621,7 @@ components: currency](https://stripe.com/docs/currencies) associated with the source. This is the currency for which the source will be chargeable once ready. Required for `single_use` sources. + format: currency nullable: true type: string customer: @@ -41476,6 +41927,7 @@ components: code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + format: currency type: string email: description: The email address of the customer placing the order. @@ -41716,6 +42168,7 @@ components: code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + format: currency type: string gbp_credit_transfer: $ref: '#/components/schemas/source_transaction_gbp_credit_transfer_data' @@ -42486,6 +42939,7 @@ components: code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + format: currency type: string current_period_end: description: >- @@ -42900,6 +43354,12 @@ components: subscription_automatic_tax: description: '' properties: + disabled_reason: + description: 'If Stripe disabled automatic tax, this enum describes why.' + enum: + - requires_location_inputs + nullable: true + type: string enabled: description: Whether Stripe automatically computes tax on this subscription. type: boolean @@ -43500,6 +43960,7 @@ components: code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + format: currency type: string default_payment_method: anyOf: @@ -43736,6 +44197,12 @@ components: subscription_schedules_resource_default_settings_automatic_tax: description: '' properties: + disabled_reason: + description: 'If Stripe disabled automatic tax, this enum describes why.' + enum: + - requires_location_inputs + nullable: true + type: string enabled: description: >- Whether Stripe automatically computes tax on invoices created during @@ -44871,32 +45338,41 @@ components: nullable: true type: description: >- - Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, - `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, + Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, + `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `ba_tin`, `bb_tin`, + `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, - `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, - `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, - `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, - `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, - `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, - `li_vat`, `ma_vat`, `md_vat`, `mx_rfc`, `my_frp`, `my_itn`, - `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, - `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, - `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, - `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `us_ein`, `uy_ruc`, - `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, or `za_vat`. Note that some - legacy tax IDs have type `unknown` + `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, + `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, + `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, + `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, + `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kh_tin`, + `kr_brn`, `kz_bin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, + `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, + `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, + `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, + `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, + `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, + `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, + `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin`. Note + that some legacy tax IDs have type `unknown` enum: - ad_nrt - ae_trn + - al_tin + - am_tin + - ao_tin - ar_cuit - au_abn - au_arn + - ba_tin + - bb_tin - bg_uic - bh_vat - bo_tin - br_cnpj - br_cpf + - bs_tin - by_tin - ca_bn - ca_gst_hst @@ -44904,6 +45380,7 @@ components: - ca_pst_mb - ca_pst_sk - ca_qst + - cd_nif - ch_uid - ch_vat - cl_tin @@ -44919,6 +45396,7 @@ components: - eu_vat - gb_vat - ge_vat + - gn_nif - hk_br - hr_oib - hu_tin @@ -44930,12 +45408,16 @@ components: - jp_rn - jp_trn - ke_pin + - kh_tin - kr_brn - kz_bin - li_uid - li_vat - ma_vat - md_vat + - me_pib + - mk_vat + - mr_nif - mx_rfc - my_frp - my_itn @@ -44943,6 +45425,7 @@ components: - ng_tin - no_vat - no_voec + - np_pan - nz_gst - om_vat - pe_ruc @@ -44955,12 +45438,16 @@ components: - sg_gst - sg_uen - si_tin + - sn_ninea + - sr_fin - sv_nit - th_vat + - tj_tin - tr_tin - tw_vat - tz_vat - ua_vat + - ug_tin - unknown - us_ein - uy_ruc @@ -44969,6 +45456,8 @@ components: - ve_rif - vn_tin - za_vat + - zm_tin + - zw_tin type: string value: description: Value of the tax ID. @@ -45027,12 +45516,27 @@ components: ae: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_default + al: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_default + am: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_simplified + ao: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_default at: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_europe au: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_default + ba: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_default + bb: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_default be: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_europe @@ -45042,12 +45546,18 @@ components: bh: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_default + bs: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_default by: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_simplified ca: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_canada + cd: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_default ch: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_default @@ -45096,6 +45606,9 @@ components: ge: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_simplified + gn: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_default gr: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_europe @@ -45123,6 +45636,9 @@ components: ke: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_simplified + kh: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_simplified kr: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_simplified @@ -45144,6 +45660,15 @@ components: md: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_simplified + me: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_default + mk: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_default + mr: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_default mt: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_europe @@ -45162,12 +45687,18 @@ components: 'no': $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_default + np: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_simplified nz: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_default om: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_default + pe: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_simplified pl: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_europe @@ -45198,18 +45729,33 @@ components: sk: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_europe + sn: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_simplified + sr: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_default th: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_simplified + tj: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_simplified tr: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_simplified tz: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_simplified + ug: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_simplified us: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_united_states + uy: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_default uz: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_simplified @@ -45219,17 +45765,30 @@ components: za: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_default + zm: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_simplified + zw: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_default title: TaxProductRegistrationsResourceCountryOptions type: object x-expandableFields: - ae + - al + - am + - ao - at - au + - ba + - bb - be - bg - bh + - bs - by - ca + - cd - ch - cl - co @@ -45246,6 +45805,7 @@ components: - fr - gb - ge + - gn - gr - hr - hu @@ -45255,6 +45815,7 @@ components: - it - jp - ke + - kh - kr - kz - lt @@ -45262,14 +45823,19 @@ components: - lv - ma - md + - me + - mk + - mr - mt - mx - my - ng - nl - 'no' + - np - nz - om + - pe - pl - pt - ro @@ -45280,13 +45846,20 @@ components: - sg - si - sk + - sn + - sr - th + - tj - tr - tz + - ug - us + - uy - uz - vn - za + - zm + - zw tax_product_registrations_resource_country_options_ca_province_standard: description: '' properties: @@ -45541,20 +46114,30 @@ components: `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, - `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, - `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, - `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, or `unknown` + `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, + `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, + `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, + `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, + `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, + `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, or + `unknown` enum: - ad_nrt - ae_trn + - al_tin + - am_tin + - ao_tin - ar_cuit - au_abn - au_arn + - ba_tin + - bb_tin - bg_uic - bh_vat - bo_tin - br_cnpj - br_cpf + - bs_tin - by_tin - ca_bn - ca_gst_hst @@ -45562,6 +46145,7 @@ components: - ca_pst_mb - ca_pst_sk - ca_qst + - cd_nif - ch_uid - ch_vat - cl_tin @@ -45577,6 +46161,7 @@ components: - eu_vat - gb_vat - ge_vat + - gn_nif - hk_br - hr_oib - hu_tin @@ -45588,12 +46173,16 @@ components: - jp_rn - jp_trn - ke_pin + - kh_tin - kr_brn - kz_bin - li_uid - li_vat - ma_vat - md_vat + - me_pib + - mk_vat + - mr_nif - mx_rfc - my_frp - my_itn @@ -45601,6 +46190,7 @@ components: - ng_tin - no_vat - no_voec + - np_pan - nz_gst - om_vat - pe_ruc @@ -45613,12 +46203,16 @@ components: - sg_gst - sg_uen - si_tin + - sn_ninea + - sr_fin - sv_nit - th_vat + - tj_tin - tr_tin - tw_vat - tz_vat - ua_vat + - ug_tin - unknown - us_ein - uy_ruc @@ -45627,6 +46221,8 @@ components: - ve_rif - vn_tin - za_vat + - zm_tin + - zw_tin type: string value: description: The value of the tax ID. @@ -46748,6 +47344,7 @@ components: code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + format: currency type: string line_items: description: List of line items in the cart. @@ -47662,6 +48259,7 @@ components: code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + format: currency type: string description: description: >- @@ -47890,6 +48488,7 @@ components: code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + format: currency type: string destination_payment_refund: anyOf: @@ -48046,6 +48645,7 @@ components: code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + format: currency type: string financial_account: description: The FinancialAccount to reverse funds from. @@ -48156,6 +48756,7 @@ components: code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + format: currency type: string financial_account: description: The FinancialAccount to reverse funds from. @@ -48487,6 +49088,7 @@ components: code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + format: currency type: string description: description: >- @@ -48652,6 +49254,7 @@ components: code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + format: currency type: string customer: description: >- @@ -48843,6 +49446,7 @@ components: code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + format: currency type: string description: description: >- @@ -48999,6 +49603,7 @@ components: code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + format: currency type: string description: description: >- @@ -49130,6 +49735,7 @@ components: code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + format: currency type: string description: description: >- @@ -49261,6 +49867,7 @@ components: code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + format: currency type: string description: description: >- @@ -49398,6 +50005,7 @@ components: code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + format: currency type: string effective_at: description: >- @@ -49561,35 +50169,6 @@ components: type: object x-expandableFields: - status_details - treasury_financial_accounts_resource_ach_toggle_settings: - description: Toggle settings for enabling/disabling an ACH specific feature - properties: - requested: - description: Whether the FinancialAccount should have the Feature. - type: boolean - status: - description: Whether the Feature is operational. - enum: - - active - - pending - - restricted - type: string - status_details: - description: >- - Additional details; includes at least one entry when the status is - not `active`. - items: - $ref: >- - #/components/schemas/treasury_financial_accounts_resource_toggles_setting_status_details - type: array - required: - - requested - - status - - status_details - title: TreasuryFinancialAccountsResourceAchToggleSettings - type: object - x-expandableFields: - - status_details treasury_financial_accounts_resource_balance: description: Balance information for the FinancialAccount properties: @@ -49672,6 +50251,35 @@ components: type: object x-expandableFields: - aba + treasury_financial_accounts_resource_inbound_ach_toggle_settings: + description: Toggle settings for enabling/disabling an inbound ACH specific feature + properties: + requested: + description: Whether the FinancialAccount should have the Feature. + type: boolean + status: + description: Whether the Feature is operational. + enum: + - active + - pending + - restricted + type: string + status_details: + description: >- + Additional details; includes at least one entry when the status is + not `active`. + items: + $ref: >- + #/components/schemas/treasury_financial_accounts_resource_toggles_setting_status_details + type: array + required: + - requested + - status + - status_details + title: TreasuryFinancialAccountsResourceInboundAchToggleSettings + type: object + x-expandableFields: + - status_details treasury_financial_accounts_resource_inbound_transfers: description: >- InboundTransfers contains inbound transfers features for a @@ -49679,17 +50287,46 @@ components: properties: ach: $ref: >- - #/components/schemas/treasury_financial_accounts_resource_ach_toggle_settings + #/components/schemas/treasury_financial_accounts_resource_inbound_ach_toggle_settings title: TreasuryFinancialAccountsResourceInboundTransfers type: object x-expandableFields: - ach + treasury_financial_accounts_resource_outbound_ach_toggle_settings: + description: Toggle settings for enabling/disabling an outbound ACH specific feature + properties: + requested: + description: Whether the FinancialAccount should have the Feature. + type: boolean + status: + description: Whether the Feature is operational. + enum: + - active + - pending + - restricted + type: string + status_details: + description: >- + Additional details; includes at least one entry when the status is + not `active`. + items: + $ref: >- + #/components/schemas/treasury_financial_accounts_resource_toggles_setting_status_details + type: array + required: + - requested + - status + - status_details + title: TreasuryFinancialAccountsResourceOutboundAchToggleSettings + type: object + x-expandableFields: + - status_details treasury_financial_accounts_resource_outbound_payments: description: Settings related to Outbound Payments features on a Financial Account properties: ach: $ref: >- - #/components/schemas/treasury_financial_accounts_resource_ach_toggle_settings + #/components/schemas/treasury_financial_accounts_resource_outbound_ach_toggle_settings us_domestic_wire: $ref: >- #/components/schemas/treasury_financial_accounts_resource_toggle_settings @@ -49705,7 +50342,7 @@ components: properties: ach: $ref: >- - #/components/schemas/treasury_financial_accounts_resource_ach_toggle_settings + #/components/schemas/treasury_financial_accounts_resource_outbound_ach_toggle_settings us_domestic_wire: $ref: >- #/components/schemas/treasury_financial_accounts_resource_toggle_settings @@ -50805,7 +51442,7 @@ info: details. termsOfService: 'https://stripe.com/us/terms/' title: Stripe API - version: 2024-10-28.acacia + version: 2024-12-18.acacia x-stripeSpecFilename: spec3 openapi: 3.0.0 paths: @@ -51410,6 +52047,7 @@ paths: maxLength: 5000 type: string currency: + format: currency type: string documents: properties: @@ -51451,6 +52089,7 @@ paths: amount: type: integer currency: + format: currency type: string fiscal_year_end: maxLength: 5000 @@ -51471,6 +52110,7 @@ paths: amount: type: integer currency: + format: currency type: string required: - amount @@ -52112,6 +52752,7 @@ paths: currency for the account. This must be a currency that [Stripe supports in the account's country](https://docs.stripe.com/payouts). + format: currency type: string documents: description: >- @@ -52224,7 +52865,7 @@ paths: groups: description: >- A hash of account group type to tokens. These are account - groups this account should be added to + groups this account should be added to. properties: payments_pricing: anyOf: @@ -52869,6 +53510,7 @@ paths: amount: type: integer currency: + format: currency type: string fiscal_year_end: maxLength: 5000 @@ -52889,6 +53531,7 @@ paths: amount: type: integer currency: + format: currency type: string required: - amount @@ -52936,7 +53579,7 @@ paths: type: string url: type: string - title: business_profile_specs + title: business_profile_update_specs type: object business_type: description: >- @@ -53467,7 +54110,7 @@ paths: type: object title: verification_specs type: object - title: company_specs + title: company_update_specs type: object default_currency: description: >- @@ -53475,6 +54118,7 @@ paths: currency for the account. This must be a currency that [Stripe supports in the account's country](https://docs.stripe.com/payouts). + format: currency type: string documents: description: >- @@ -53587,7 +54231,7 @@ paths: groups: description: >- A hash of account group type to tokens. These are account - groups this account should be added to + groups this account should be added to. properties: payments_pricing: anyOf: @@ -53822,7 +54466,7 @@ paths: type: object title: person_verification_specs type: object - title: individual_specs + title: individual_update_specs type: object metadata: anyOf: @@ -54099,6 +54743,7 @@ paths: maxLength: 5000 type: string currency: + format: currency type: string documents: properties: @@ -54823,6 +55468,7 @@ paths: maxLength: 5000 type: string currency: + format: currency type: string documents: properties: @@ -55277,6 +55923,8 @@ paths: required: false schema: properties: + authorizer: + type: boolean director: type: boolean executive: @@ -55716,6 +56364,8 @@ paths: The relationship that this person has with the account's legal entity. properties: + authorizer: + type: boolean director: type: boolean executive: @@ -56250,6 +56900,8 @@ paths: The relationship that this person has with the account's legal entity. properties: + authorizer: + type: boolean director: type: boolean executive: @@ -56374,6 +57026,8 @@ paths: required: false schema: properties: + authorizer: + type: boolean director: type: boolean executive: @@ -56813,6 +57467,8 @@ paths: The relationship that this person has with the account's legal entity. properties: + authorizer: + type: boolean director: type: boolean executive: @@ -57347,6 +58003,8 @@ paths: The relationship that this person has with the account's legal entity. properties: + authorizer: + type: boolean director: type: boolean executive: @@ -58693,6 +59351,7 @@ paths: name: currency required: false schema: + format: currency type: string style: form - description: >- @@ -58770,8 +59429,9 @@ paths: `obligation_reversal_inbound`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, - `payout`, `payout_cancel`, `payout_failure`, `refund`, - `refund_failure`, `reserve_transaction`, `reserved_funds`, + `payout`, `payout_cancel`, `payout_failure`, + `payout_minimum_balance_hold`, `payout_minimum_balance_release`, + `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`. @@ -58931,6 +59591,7 @@ paths: name: currency required: false schema: + format: currency type: string style: form - description: >- @@ -59008,8 +59669,9 @@ paths: `obligation_reversal_inbound`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, - `payout`, `payout_cancel`, `payout_failure`, `refund`, - `refund_failure`, `reserve_transaction`, `reserved_funds`, + `payout`, `payout_cancel`, `payout_failure`, + `payout_minimum_balance_hold`, `payout_minimum_balance_release`, + `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`. @@ -59514,7 +60176,7 @@ paths: summary: Deactivate a billing alert /v1/billing/credit_balance_summary: get: - description:

Retrieves the credit balance summary for a customer

+ description:

Retrieves the credit balance summary for a customer.

operationId: GetBillingCreditBalanceSummary parameters: - description: The customer for which to fetch credit balance summary. @@ -59591,7 +60253,7 @@ paths: summary: Retrieve the credit balance summary for a customer /v1/billing/credit_balance_transactions: get: - description:

Retrieve a list of credit balance transactions

+ description:

Retrieve a list of credit balance transactions.

operationId: GetBillingCreditBalanceTransactions parameters: - description: The credit grant for which to fetch credit balance transactions. @@ -59712,7 +60374,7 @@ paths: summary: List credit balance transactions '/v1/billing/credit_balance_transactions/{id}': get: - description:

Retrieves a credit balance transaction

+ description:

Retrieves a credit balance transaction.

operationId: GetBillingCreditBalanceTransactionsId parameters: - description: Specifies which fields in the response should be expanded. @@ -59871,7 +60533,7 @@ paths: description: Error response. summary: List credit grants post: - description:

Creates a credit grant

+ description:

Creates a credit grant.

operationId: PostBillingCreditGrants requestBody: content: @@ -59898,6 +60560,7 @@ paths: monetary: properties: currency: + format: currency type: string value: type: integer @@ -59943,9 +60606,9 @@ paths: type: string effective_at: description: >- - The time when the billing credits become effective—when - they're eligible for use. Defaults to the current timestamp - if not specified. + The time when the billing credits become effective-when + they're eligible for use. It defaults to the current + timestamp if not specified. format: unix-time type: integer expand: @@ -59956,17 +60619,17 @@ paths: type: array expires_at: description: >- - The time when the billing credits will expire. If not - specified, the billing credits don't expire. + The time when the billing credits expire. If not specified, + the billing credits don't expire. format: unix-time type: integer metadata: additionalProperties: type: string description: >- - Set of key-value pairs that you can attach to an object. - This can be useful for storing additional information about - the object (for example, cost basis) in a structured format. + Set of key-value pairs that you can attach to an object. You + can use this to store additional information about the + object (for example, cost basis) in a structured format. type: object name: description: A descriptive name shown in the Dashboard. @@ -59995,7 +60658,7 @@ paths: summary: Create a credit grant '/v1/billing/credit_grants/{id}': get: - description:

Retrieves a credit grant

+ description:

Retrieves a credit grant.

operationId: GetBillingCreditGrantsId parameters: - description: Specifies which fields in the response should be expanded. @@ -60041,7 +60704,7 @@ paths: description: Error response. summary: Retrieve a credit grant post: - description:

Updates a credit grant

+ description:

Updates a credit grant.

operationId: PostBillingCreditGrantsId parameters: - description: Unique identifier for the object. @@ -60089,9 +60752,9 @@ paths: additionalProperties: type: string description: >- - Set of key-value pairs you can attach to an object. This can - be useful for storing additional information about the - object (for example, cost basis) in a structured format. + Set of key-value pairs you can attach to an object. You can + use this to store additional information about the object + (for example, cost basis) in a structured format. type: object type: object required: false @@ -60201,7 +60864,7 @@ paths: summary: Void a credit grant /v1/billing/meter_event_adjustments: post: - description:

Creates a billing meter event adjustment

+ description:

Creates a billing meter event adjustment.

operationId: PostBillingMeterEventAdjustments requestBody: content: @@ -60265,7 +60928,7 @@ paths: summary: Create a billing meter event adjustment /v1/billing/meter_events: post: - description:

Creates a billing meter event

+ description:

Creates a billing meter event.

operationId: PostBillingMeterEvents requestBody: content: @@ -60294,14 +60957,14 @@ paths: type: array identifier: description: >- - A unique identifier for the event. If not provided, one will - be generated. We strongly advise using UUID-like - identifiers. We will enforce uniqueness within a rolling - period of at least 24 hours. The enforcement of uniqueness - primarily addresses issues arising from accidental retries - or other problems occurring within extremely brief time - intervals. This approach helps prevent duplicate entries and - ensures data integrity in high-frequency operations. + A unique identifier for the event. If not provided, one is + generated. We recommend using UUID-like identifiers. We will + enforce uniqueness within a rolling period of at least 24 + hours. The enforcement of uniqueness primarily addresses + issues arising from accidental retries or other problems + occurring within extremely brief time intervals. This + approach helps prevent duplicate entries and ensures data + integrity in high-frequency operations. maxLength: 100 type: string payload: @@ -60458,7 +61121,7 @@ paths: description: Error response. summary: List billing meters post: - description:

Creates a billing meter

+ description:

Creates a billing meter.

operationId: PostBillingMeters requestBody: content: @@ -60507,7 +61170,7 @@ paths: title: aggregation_settings_param type: object display_name: - description: The meter's name. + description: The meter’s name. Not visible to the customer. maxLength: 250 type: string event_name: @@ -60560,7 +61223,7 @@ paths: summary: Create a billing meter '/v1/billing/meters/{id}': get: - description:

Retrieves a billing meter given an ID

+ description:

Retrieves a billing meter given an ID.

operationId: GetBillingMetersId parameters: - description: Specifies which fields in the response should be expanded. @@ -60606,7 +61269,7 @@ paths: description: Error response. summary: Retrieve a billing meter post: - description:

Updates a billing meter

+ description:

Updates a billing meter.

operationId: PostBillingMetersId parameters: - description: Unique identifier for the object. @@ -60628,7 +61291,7 @@ paths: additionalProperties: false properties: display_name: - description: The meter's name. + description: The meter’s name. Not visible to the customer. maxLength: 250 type: string expand: @@ -60655,7 +61318,9 @@ paths: summary: Update a billing meter '/v1/billing/meters/{id}/deactivate': post: - description:

Deactivates a billing meter

+ description: >- +

When a meter is deactivated, no more meter events will be accepted + for this meter. You can’t attach a deactivated meter to a price.

operationId: PostBillingMetersIdDeactivate parameters: - description: Unique identifier for the object. @@ -60857,7 +61522,9 @@ paths: summary: List billing meter event summaries '/v1/billing/meters/{id}/reactivate': post: - description:

Reactivates a billing meter

+ description: >- +

When a meter is reactivated, events for this meter can be accepted + and you can attach the meter to a price.

operationId: PostBillingMetersIdReactivate parameters: - description: Unique identifier for the object. @@ -62146,6 +62813,7 @@ paths: code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + format: currency type: string customer: description: >- @@ -63136,6 +63804,12 @@ paths: type: array title: visa_compelling_evidence3 type: object + visa_compliance: + properties: + fee_acknowledged: + type: boolean + title: visa_compliance + type: object title: enhanced_evidence type: object - enum: @@ -63574,6 +64248,7 @@ paths: code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + format: currency type: string customer: description: Customer whose customer balance to refund from. @@ -64150,6 +64825,7 @@ paths: lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Required in `setup` mode when `payment_method_types` is not set. + format: currency type: string custom_fields: description: >- @@ -64550,6 +65226,7 @@ paths: price_data: properties: currency: + format: currency type: string product: maxLength: 5000 @@ -64919,7 +65596,14 @@ paths: bacs_debit: properties: mandate_options: - properties: {} + properties: + reference_prefix: + anyOf: + - maxLength: 12 + type: string + - enum: + - '' + type: string title: payment_method_options_mandate_options_param type: object setup_future_usage: @@ -65287,7 +65971,14 @@ paths: sepa_debit: properties: mandate_options: - properties: {} + properties: + reference_prefix: + anyOf: + - maxLength: 12 + type: string + - enum: + - '' + type: string title: payment_method_options_mandate_options_param type: object setup_future_usage: @@ -65775,6 +66466,7 @@ paths: - ZW - ZZ type: string + x-stripeBypassValidation: true type: array required: - allowed_countries @@ -65837,6 +66529,7 @@ paths: amount: type: integer currency: + format: currency type: string currency_options: additionalProperties: @@ -67389,6 +68082,7 @@ paths: Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the `amount_off` parameter (required if `amount_off` is passed). + format: currency type: string currency_options: additionalProperties: @@ -69400,14 +70094,20 @@ paths: enum: - ad_nrt - ae_trn + - al_tin + - am_tin + - ao_tin - ar_cuit - au_abn - au_arn + - ba_tin + - bb_tin - bg_uic - bh_vat - bo_tin - br_cnpj - br_cpf + - bs_tin - by_tin - ca_bn - ca_gst_hst @@ -69415,6 +70115,7 @@ paths: - ca_pst_mb - ca_pst_sk - ca_qst + - cd_nif - ch_uid - ch_vat - cl_tin @@ -69430,6 +70131,7 @@ paths: - eu_vat - gb_vat - ge_vat + - gn_nif - hk_br - hr_oib - hu_tin @@ -69441,12 +70143,16 @@ paths: - jp_rn - jp_trn - ke_pin + - kh_tin - kr_brn - kz_bin - li_uid - li_vat - ma_vat - md_vat + - me_pib + - mk_vat + - mr_nif - mx_rfc - my_frp - my_itn @@ -69454,6 +70160,7 @@ paths: - ng_tin - no_vat - no_voec + - np_pan - nz_gst - om_vat - pe_ruc @@ -69466,12 +70173,16 @@ paths: - sg_gst - sg_uen - si_tin + - sn_ninea + - sr_fin - sv_nit - th_vat + - tj_tin - tr_tin - tw_vat - tz_vat - ua_vat + - ug_tin - us_ein - uy_ruc - uz_tin @@ -69479,6 +70190,8 @@ paths: - ve_rif - vn_tin - za_vat + - zm_tin + - zw_tin maxLength: 5000 type: string x-stripeBypassValidation: true @@ -69830,6 +70543,7 @@ paths: maxLength: 5000 type: string currency: + format: currency type: string object: enum: @@ -70320,6 +71034,7 @@ paths: [`invoice_credit_balance`](https://stripe.com/docs/api/customers/object#customer_object-invoice_credit_balance) that this transaction will apply to. If the customer's `currency` is not set, it will be updated to this value. + format: currency type: string description: description: >- @@ -70682,6 +71397,7 @@ paths: maxLength: 5000 type: string currency: + format: currency type: string object: enum: @@ -71311,6 +72027,7 @@ paths: maxLength: 5000 type: string currency: + format: currency type: string object: enum: @@ -72129,6 +72846,7 @@ paths: code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + format: currency type: string expand: description: Specifies which fields in the response should be expanded. @@ -72585,6 +73303,7 @@ paths: maxLength: 5000 type: string currency: + format: currency type: string object: enum: @@ -73232,6 +73951,7 @@ paths: price_data: properties: currency: + format: currency type: string product: maxLength: 5000 @@ -73386,6 +74106,7 @@ paths: code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + format: currency type: string days_until_due: description: >- @@ -73532,6 +74253,7 @@ paths: price_data: properties: currency: + format: currency type: string product: maxLength: 5000 @@ -74284,6 +75006,7 @@ paths: price_data: properties: currency: + format: currency type: string product: maxLength: 5000 @@ -74612,6 +75335,7 @@ paths: price_data: properties: currency: + format: currency type: string product: maxLength: 5000 @@ -75366,32 +76090,41 @@ paths: type: array type: description: >- - Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, - `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, - `br_cpf`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, - `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, - `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, - `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, - `gb_vat`, `ge_vat`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, - `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, - `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `li_vat`, `ma_vat`, - `md_vat`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, - `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, - `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, - `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, - `tz_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, - `ve_rif`, `vn_tin`, or `za_vat` + Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, + `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `ba_tin`, + `bb_tin`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, + `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, + `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, + `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, + `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, + `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, + `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, + `jp_rn`, `jp_trn`, `ke_pin`, `kh_tin`, `kr_brn`, `kz_bin`, + `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, + `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, + `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, + `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, + `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, + `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, + `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, + `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin` enum: - ad_nrt - ae_trn + - al_tin + - am_tin + - ao_tin - ar_cuit - au_abn - au_arn + - ba_tin + - bb_tin - bg_uic - bh_vat - bo_tin - br_cnpj - br_cpf + - bs_tin - by_tin - ca_bn - ca_gst_hst @@ -75399,6 +76132,7 @@ paths: - ca_pst_mb - ca_pst_sk - ca_qst + - cd_nif - ch_uid - ch_vat - cl_tin @@ -75414,6 +76148,7 @@ paths: - eu_vat - gb_vat - ge_vat + - gn_nif - hk_br - hr_oib - hu_tin @@ -75425,12 +76160,16 @@ paths: - jp_rn - jp_trn - ke_pin + - kh_tin - kr_brn - kz_bin - li_uid - li_vat - ma_vat - md_vat + - me_pib + - mk_vat + - mr_nif - mx_rfc - my_frp - my_itn @@ -75438,6 +76177,7 @@ paths: - ng_tin - no_vat - no_voec + - np_pan - nz_gst - om_vat - pe_ruc @@ -75450,12 +76190,16 @@ paths: - sg_gst - sg_uen - si_tin + - sn_ninea + - sr_fin - sv_nit - th_vat + - tj_tin - tr_tin - tw_vat - tz_vat - ua_vat + - ug_tin - us_ein - uy_ruc - uz_tin @@ -75463,6 +76207,8 @@ paths: - ve_rif - vn_tin - za_vat + - zm_tin + - zw_tin maxLength: 5000 type: string x-stripeBypassValidation: true @@ -76060,6 +76806,12 @@ paths: type: array title: visa_compelling_evidence3 type: object + visa_compliance: + properties: + fee_acknowledged: + type: boolean + title: visa_compliance + type: object title: enhanced_evidence type: object - enum: @@ -78870,6 +79622,7 @@ paths: - card_expiry - card_number - cardholder_name + - request_signature type: string type: array request: @@ -80264,6 +81017,7 @@ paths: code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + format: currency type: string customer: description: >- @@ -80373,6 +81127,7 @@ paths: One of `price` or `price_data` is required. properties: currency: + format: currency type: string product: maxLength: 5000 @@ -80699,6 +81454,7 @@ paths: One of `price` or `price_data` is required. properties: currency: + format: currency type: string product: maxLength: 5000 @@ -81116,6 +81872,7 @@ paths: description: >- The currency to create this invoice in. Defaults to that of `customer` if not specified. + format: currency type: string custom_fields: anyOf: @@ -81635,6 +82392,7 @@ paths: amount: type: integer currency: + format: currency type: string currency_options: additionalProperties: @@ -81870,6 +82628,7 @@ paths: description: >- The currency to preview this invoice in. Defaults to that of `customer` if not specified. + format: currency type: string customer: description: >- @@ -81975,14 +82734,20 @@ paths: enum: - ad_nrt - ae_trn + - al_tin + - am_tin + - ao_tin - ar_cuit - au_abn - au_arn + - ba_tin + - bb_tin - bg_uic - bh_vat - bo_tin - br_cnpj - br_cpf + - bs_tin - by_tin - ca_bn - ca_gst_hst @@ -81990,6 +82755,7 @@ paths: - ca_pst_mb - ca_pst_sk - ca_qst + - cd_nif - ch_uid - ch_vat - cl_tin @@ -82005,6 +82771,7 @@ paths: - eu_vat - gb_vat - ge_vat + - gn_nif - hk_br - hr_oib - hu_tin @@ -82016,12 +82783,16 @@ paths: - jp_rn - jp_trn - ke_pin + - kh_tin - kr_brn - kz_bin - li_uid - li_vat - ma_vat - md_vat + - me_pib + - mk_vat + - mr_nif - mx_rfc - my_frp - my_itn @@ -82029,6 +82800,7 @@ paths: - ng_tin - no_vat - no_voec + - np_pan - nz_gst - om_vat - pe_ruc @@ -82041,12 +82813,16 @@ paths: - sg_gst - sg_uen - si_tin + - sn_ninea + - sr_fin - sv_nit - th_vat + - tj_tin - tr_tin - tw_vat - tz_vat - ua_vat + - ug_tin - us_ein - uy_ruc - uz_tin @@ -82054,6 +82830,8 @@ paths: - ve_rif - vn_tin - za_vat + - zm_tin + - zw_tin maxLength: 5000 type: string x-stripeBypassValidation: true @@ -82108,6 +82886,7 @@ paths: amount: type: integer currency: + format: currency type: string description: maxLength: 5000 @@ -82163,6 +82942,7 @@ paths: price_data: properties: currency: + format: currency type: string product: maxLength: 5000 @@ -82297,6 +83077,7 @@ paths: price_data: properties: currency: + format: currency type: string product: maxLength: 5000 @@ -82497,6 +83278,7 @@ paths: price_data: properties: currency: + format: currency type: string product: maxLength: 5000 @@ -82703,6 +83485,7 @@ paths: price_data: properties: currency: + format: currency type: string product: maxLength: 5000 @@ -82992,6 +83775,7 @@ paths: name: currency required: false schema: + format: currency type: string style: form - description: >- @@ -83105,14 +83889,20 @@ paths: enum: - ad_nrt - ae_trn + - al_tin + - am_tin + - ao_tin - ar_cuit - au_abn - au_arn + - ba_tin + - bb_tin - bg_uic - bh_vat - bo_tin - br_cnpj - br_cpf + - bs_tin - by_tin - ca_bn - ca_gst_hst @@ -83120,6 +83910,7 @@ paths: - ca_pst_mb - ca_pst_sk - ca_qst + - cd_nif - ch_uid - ch_vat - cl_tin @@ -83135,6 +83926,7 @@ paths: - eu_vat - gb_vat - ge_vat + - gn_nif - hk_br - hr_oib - hu_tin @@ -83146,12 +83938,16 @@ paths: - jp_rn - jp_trn - ke_pin + - kh_tin - kr_brn - kz_bin - li_uid - li_vat - ma_vat - md_vat + - me_pib + - mk_vat + - mr_nif - mx_rfc - my_frp - my_itn @@ -83159,6 +83955,7 @@ paths: - ng_tin - no_vat - no_voec + - np_pan - nz_gst - om_vat - pe_ruc @@ -83171,12 +83968,16 @@ paths: - sg_gst - sg_uen - si_tin + - sn_ninea + - sr_fin - sv_nit - th_vat + - tj_tin - tr_tin - tw_vat - tz_vat - ua_vat + - ug_tin - us_ein - uy_ruc - uz_tin @@ -83184,6 +83985,8 @@ paths: - ve_rif - vn_tin - za_vat + - zm_tin + - zw_tin maxLength: 5000 type: string x-stripeBypassValidation: true @@ -83252,6 +84055,7 @@ paths: amount: type: integer currency: + format: currency type: string description: maxLength: 5000 @@ -83307,6 +84111,7 @@ paths: price_data: properties: currency: + format: currency type: string product: maxLength: 5000 @@ -83462,6 +84267,7 @@ paths: price_data: properties: currency: + format: currency type: string product: maxLength: 5000 @@ -83662,6 +84468,7 @@ paths: price_data: properties: currency: + format: currency type: string product: maxLength: 5000 @@ -83960,6 +84767,7 @@ paths: price_data: properties: currency: + format: currency type: string product: maxLength: 5000 @@ -84101,6 +84909,7 @@ paths: price_data: properties: currency: + format: currency type: string product: maxLength: 5000 @@ -84309,6 +85118,7 @@ paths: name: currency required: false schema: + format: currency type: string style: form - description: >- @@ -84422,14 +85232,20 @@ paths: enum: - ad_nrt - ae_trn + - al_tin + - am_tin + - ao_tin - ar_cuit - au_abn - au_arn + - ba_tin + - bb_tin - bg_uic - bh_vat - bo_tin - br_cnpj - br_cpf + - bs_tin - by_tin - ca_bn - ca_gst_hst @@ -84437,6 +85253,7 @@ paths: - ca_pst_mb - ca_pst_sk - ca_qst + - cd_nif - ch_uid - ch_vat - cl_tin @@ -84452,6 +85269,7 @@ paths: - eu_vat - gb_vat - ge_vat + - gn_nif - hk_br - hr_oib - hu_tin @@ -84463,12 +85281,16 @@ paths: - jp_rn - jp_trn - ke_pin + - kh_tin - kr_brn - kz_bin - li_uid - li_vat - ma_vat - md_vat + - me_pib + - mk_vat + - mr_nif - mx_rfc - my_frp - my_itn @@ -84476,6 +85298,7 @@ paths: - ng_tin - no_vat - no_voec + - np_pan - nz_gst - om_vat - pe_ruc @@ -84488,12 +85311,16 @@ paths: - sg_gst - sg_uen - si_tin + - sn_ninea + - sr_fin - sv_nit - th_vat + - tj_tin - tr_tin - tw_vat - tz_vat - ua_vat + - ug_tin - us_ein - uy_ruc - uz_tin @@ -84501,6 +85328,8 @@ paths: - ve_rif - vn_tin - za_vat + - zm_tin + - zw_tin maxLength: 5000 type: string x-stripeBypassValidation: true @@ -84582,6 +85411,7 @@ paths: amount: type: integer currency: + format: currency type: string description: maxLength: 5000 @@ -84637,6 +85467,7 @@ paths: price_data: properties: currency: + format: currency type: string product: maxLength: 5000 @@ -84801,6 +85632,7 @@ paths: price_data: properties: currency: + format: currency type: string product: maxLength: 5000 @@ -85001,6 +85833,7 @@ paths: price_data: properties: currency: + format: currency type: string product: maxLength: 5000 @@ -85312,6 +86145,7 @@ paths: price_data: properties: currency: + format: currency type: string product: maxLength: 5000 @@ -85453,6 +86287,7 @@ paths: price_data: properties: currency: + format: currency type: string product: maxLength: 5000 @@ -86380,6 +87215,7 @@ paths: amount: type: integer currency: + format: currency type: string currency_options: additionalProperties: @@ -86631,6 +87467,7 @@ paths: price_data: properties: currency: + format: currency type: string product: maxLength: 5000 @@ -87105,6 +87942,7 @@ paths: One of `price` or `price_data` is required. properties: currency: + format: currency type: string product: maxLength: 5000 @@ -87671,6 +88509,7 @@ paths: price_data: properties: currency: + format: currency type: string product: maxLength: 5000 @@ -96767,6 +97606,7 @@ paths: code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + format: currency type: string customer: description: >- @@ -97576,7 +98416,14 @@ paths: anyOf: - properties: mandate_options: - properties: {} + properties: + reference_prefix: + anyOf: + - maxLength: 12 + type: string + - enum: + - '' + type: string title: payment_method_options_mandate_options_param type: object setup_future_usage: @@ -98412,7 +99259,14 @@ paths: anyOf: - properties: mandate_options: - properties: {} + properties: + reference_prefix: + anyOf: + - maxLength: 12 + type: string + - enum: + - '' + type: string title: payment_method_options_mandate_options_param type: object setup_future_usage: @@ -99078,6 +99932,7 @@ paths: code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + format: currency type: string customer: description: >- @@ -99801,7 +100656,14 @@ paths: anyOf: - properties: mandate_options: - properties: {} + properties: + reference_prefix: + anyOf: + - maxLength: 12 + type: string + - enum: + - '' + type: string title: payment_method_options_mandate_options_param type: object setup_future_usage: @@ -100637,7 +101499,14 @@ paths: anyOf: - properties: mandate_options: - properties: {} + properties: + reference_prefix: + anyOf: + - maxLength: 12 + type: string + - enum: + - '' + type: string title: payment_method_options_mandate_options_param type: object setup_future_usage: @@ -101046,6 +101915,7 @@ paths: code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + format: currency type: string expand: description: Specifies which fields in the response should be expanded. @@ -102180,7 +103050,14 @@ paths: anyOf: - properties: mandate_options: - properties: {} + properties: + reference_prefix: + anyOf: + - maxLength: 12 + type: string + - enum: + - '' + type: string title: payment_method_options_mandate_options_param type: object setup_future_usage: @@ -103016,7 +103893,14 @@ paths: anyOf: - properties: mandate_options: - properties: {} + properties: + reference_prefix: + anyOf: + - maxLength: 12 + type: string + - enum: + - '' + type: string title: payment_method_options_mandate_options_param type: object setup_future_usage: @@ -103872,6 +104756,7 @@ paths: lowercase. Must be a [supported currency](https://stripe.com/docs/currencies) and supported by each line item's price. + format: currency type: string custom_fields: description: >- @@ -104536,6 +105421,7 @@ paths: - ZW - ZZ type: string + x-stripeBypassValidation: true type: array required: - allowed_countries @@ -105509,6 +106395,7 @@ paths: - ZW - ZZ type: string + x-stripeBypassValidation: true type: array required: - allowed_countries @@ -105566,6 +106453,12 @@ paths: - enum: - '' type: string + trial_period_days: + anyOf: + - type: integer + - enum: + - '' + type: string trial_settings: anyOf: - properties: @@ -109989,6 +110882,7 @@ paths: code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + format: currency type: string description: description: >- @@ -110532,6 +111426,7 @@ paths: code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + format: currency type: string expand: description: Specifies which fields in the response should be expanded. @@ -110937,6 +111832,7 @@ paths: name: currency required: false schema: + format: currency type: string style: form - description: >- @@ -111157,6 +112053,7 @@ paths: code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + format: currency type: string currency_options: additionalProperties: @@ -111984,6 +112881,7 @@ paths: Price will be set as the default price for this product. properties: currency: + format: currency type: string currency_options: additionalProperties: @@ -113137,6 +114035,7 @@ paths: minimum_amount: type: integer minimum_amount_currency: + format: currency type: string title: restrictions_params type: object @@ -113716,6 +114615,7 @@ paths: price_data: properties: currency: + format: currency type: string product: maxLength: 5000 @@ -114160,6 +115060,7 @@ paths: price_data: properties: currency: + format: currency type: string product: maxLength: 5000 @@ -115783,6 +116684,7 @@ paths: code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + format: currency type: string customer: description: Customer whose customer balance to refund from. @@ -116206,6 +117108,7 @@ paths: connected_account: type: string currency: + format: currency type: string interval_end: format: unix-time @@ -118334,7 +119237,14 @@ paths: bacs_debit: properties: mandate_options: - properties: {} + properties: + reference_prefix: + anyOf: + - maxLength: 12 + type: string + - enum: + - '' + type: string title: payment_method_options_mandate_options_param type: object title: setup_intent_payment_method_options_param @@ -118351,6 +119261,7 @@ paths: - maximum type: string currency: + format: currency type: string description: maxLength: 200 @@ -118497,7 +119408,14 @@ paths: sepa_debit: properties: mandate_options: - properties: {} + properties: + reference_prefix: + anyOf: + - maxLength: 12 + type: string + - enum: + - '' + type: string title: payment_method_options_mandate_options_param type: object title: setup_intent_payment_method_options_param @@ -118603,6 +119521,7 @@ paths: amount: type: integer currency: + format: currency type: string required: - amount @@ -119381,7 +120300,14 @@ paths: bacs_debit: properties: mandate_options: - properties: {} + properties: + reference_prefix: + anyOf: + - maxLength: 12 + type: string + - enum: + - '' + type: string title: payment_method_options_mandate_options_param type: object title: setup_intent_payment_method_options_param @@ -119398,6 +120324,7 @@ paths: - maximum type: string currency: + format: currency type: string description: maxLength: 200 @@ -119544,7 +120471,14 @@ paths: sepa_debit: properties: mandate_options: - properties: {} + properties: + reference_prefix: + anyOf: + - maxLength: 12 + type: string + - enum: + - '' + type: string title: payment_method_options_mandate_options_param type: object title: setup_intent_payment_method_options_param @@ -120421,7 +121355,14 @@ paths: bacs_debit: properties: mandate_options: - properties: {} + properties: + reference_prefix: + anyOf: + - maxLength: 12 + type: string + - enum: + - '' + type: string title: payment_method_options_mandate_options_param type: object title: setup_intent_payment_method_options_param @@ -120438,6 +121379,7 @@ paths: - maximum type: string currency: + format: currency type: string description: maxLength: 200 @@ -120584,7 +121526,14 @@ paths: sepa_debit: properties: mandate_options: - properties: {} + properties: + reference_prefix: + anyOf: + - maxLength: 12 + type: string + - enum: + - '' + type: string title: payment_method_options_mandate_options_param type: object title: setup_intent_payment_method_options_param @@ -120799,6 +121748,7 @@ paths: name: currency required: false schema: + format: currency type: string style: form - description: >- @@ -120985,6 +121935,7 @@ paths: amount: type: integer currency: + format: currency type: string currency_options: additionalProperties: @@ -121401,6 +122352,7 @@ paths: currency](https://stripe.com/docs/currencies) associated with the source. This is the currency for which the source will be chargeable once ready. + format: currency type: string customer: description: >- @@ -121489,6 +122441,7 @@ paths: - '' type: string currency: + format: currency type: string interval: enum: @@ -121591,6 +122544,7 @@ paths: amount: type: integer currency: + format: currency type: string description: maxLength: 1000 @@ -121872,6 +122826,7 @@ paths: - '' type: string currency: + format: currency type: string interval: enum: @@ -121956,6 +122911,7 @@ paths: amount: type: integer currency: + format: currency type: string description: maxLength: 1000 @@ -122565,6 +123521,7 @@ paths: [Price](https://stripe.com/docs/api/prices) object inline. properties: currency: + format: currency type: string product: maxLength: 5000 @@ -122941,6 +123898,7 @@ paths: One of `price` or `price_data` is required. properties: currency: + format: currency type: string product: maxLength: 5000 @@ -123696,6 +124654,7 @@ paths: price_data: properties: currency: + format: currency type: string product: maxLength: 5000 @@ -123779,6 +124738,7 @@ paths: maxLength: 5000 type: string currency: + format: currency type: string default_payment_method: maxLength: 5000 @@ -123893,6 +124853,7 @@ paths: price_data: properties: currency: + format: currency type: string product: maxLength: 5000 @@ -124265,6 +125226,7 @@ paths: price_data: properties: currency: + format: currency type: string product: maxLength: 5000 @@ -124465,6 +125427,7 @@ paths: price_data: properties: currency: + format: currency type: string product: maxLength: 5000 @@ -125066,6 +126029,7 @@ paths: price_data: properties: currency: + format: currency type: string product: maxLength: 5000 @@ -125241,6 +126205,7 @@ paths: code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + format: currency type: string customer: description: The identifier of the customer to subscribe. @@ -125399,6 +126364,7 @@ paths: price_data: properties: currency: + format: currency type: string product: maxLength: 5000 @@ -126350,6 +127316,7 @@ paths: price_data: properties: currency: + format: currency type: string product: maxLength: 5000 @@ -126691,6 +127658,7 @@ paths: price_data: properties: currency: + format: currency type: string product: maxLength: 5000 @@ -127373,6 +128341,7 @@ paths: code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + format: currency type: string customer: description: >- @@ -127442,14 +128411,20 @@ paths: enum: - ad_nrt - ae_trn + - al_tin + - am_tin + - ao_tin - ar_cuit - au_abn - au_arn + - ba_tin + - bb_tin - bg_uic - bh_vat - bo_tin - br_cnpj - br_cpf + - bs_tin - by_tin - ca_bn - ca_gst_hst @@ -127457,6 +128432,7 @@ paths: - ca_pst_mb - ca_pst_sk - ca_qst + - cd_nif - ch_uid - ch_vat - cl_tin @@ -127472,6 +128448,7 @@ paths: - eu_vat - gb_vat - ge_vat + - gn_nif - hk_br - hr_oib - hu_tin @@ -127483,12 +128460,16 @@ paths: - jp_rn - jp_trn - ke_pin + - kh_tin - kr_brn - kz_bin - li_uid - li_vat - ma_vat - md_vat + - me_pib + - mk_vat + - mr_nif - mx_rfc - my_frp - my_itn @@ -127496,6 +128477,7 @@ paths: - ng_tin - no_vat - no_voec + - np_pan - nz_gst - om_vat - pe_ruc @@ -127508,12 +128490,16 @@ paths: - sg_gst - sg_uen - si_tin + - sn_ninea + - sr_fin - sv_nit - th_vat + - tj_tin - tr_tin - tw_vat - tz_vat - ua_vat + - ug_tin - us_ein - uy_ruc - uz_tin @@ -127521,6 +128507,8 @@ paths: - ve_rif - vn_tin - za_vat + - zm_tin + - zw_tin maxLength: 5000 type: string x-stripeBypassValidation: true @@ -128000,6 +128988,36 @@ paths: - type title: default type: object + al: + properties: + type: + enum: + - standard + type: string + required: + - type + title: default + type: object + am: + properties: + type: + enum: + - simplified + type: string + required: + - type + title: simplified + type: object + ao: + properties: + type: + enum: + - standard + type: string + required: + - type + title: default + type: object at: properties: standard: @@ -128034,6 +129052,26 @@ paths: - type title: default type: object + ba: + properties: + type: + enum: + - standard + type: string + required: + - type + title: default + type: object + bb: + properties: + type: + enum: + - standard + type: string + required: + - type + title: default + type: object be: properties: standard: @@ -128092,6 +129130,16 @@ paths: - type title: default type: object + bs: + properties: + type: + enum: + - standard + type: string + required: + - type + title: default + type: object by: properties: type: @@ -128123,6 +129171,16 @@ paths: - type title: canada type: object + cd: + properties: + type: + enum: + - standard + type: string + required: + - type + title: default + type: object ch: properties: type: @@ -128375,7 +129433,177 @@ paths: - type title: europe type: object - gb: + gb: + properties: + type: + enum: + - standard + type: string + required: + - type + title: default + type: object + ge: + properties: + type: + enum: + - simplified + type: string + required: + - type + title: simplified + type: object + gn: + properties: + type: + enum: + - standard + type: string + required: + - type + title: default + type: object + gr: + properties: + standard: + properties: + place_of_supply_scheme: + enum: + - small_seller + - standard + type: string + required: + - place_of_supply_scheme + title: standard + type: object + type: + enum: + - ioss + - oss_non_union + - oss_union + - standard + type: string + required: + - type + title: europe + type: object + hr: + properties: + standard: + properties: + place_of_supply_scheme: + enum: + - small_seller + - standard + type: string + required: + - place_of_supply_scheme + title: standard + type: object + type: + enum: + - ioss + - oss_non_union + - oss_union + - standard + type: string + required: + - type + title: europe + type: object + hu: + properties: + standard: + properties: + place_of_supply_scheme: + enum: + - small_seller + - standard + type: string + required: + - place_of_supply_scheme + title: standard + type: object + type: + enum: + - ioss + - oss_non_union + - oss_union + - standard + type: string + required: + - type + title: europe + type: object + id: + properties: + type: + enum: + - simplified + type: string + required: + - type + title: simplified + type: object + ie: + properties: + standard: + properties: + place_of_supply_scheme: + enum: + - small_seller + - standard + type: string + required: + - place_of_supply_scheme + title: standard + type: object + type: + enum: + - ioss + - oss_non_union + - oss_union + - standard + type: string + required: + - type + title: europe + type: object + is: + properties: + type: + enum: + - standard + type: string + required: + - type + title: default + type: object + it: + properties: + standard: + properties: + place_of_supply_scheme: + enum: + - small_seller + - standard + type: string + required: + - place_of_supply_scheme + title: standard + type: object + type: + enum: + - ioss + - oss_non_union + - oss_union + - standard + type: string + required: + - type + title: europe + type: object + jp: properties: type: enum: @@ -128385,7 +129613,7 @@ paths: - type title: default type: object - ge: + ke: properties: type: enum: @@ -128395,55 +129623,37 @@ paths: - type title: simplified type: object - gr: + kh: properties: - standard: - properties: - place_of_supply_scheme: - enum: - - small_seller - - standard - type: string - required: - - place_of_supply_scheme - title: standard - type: object type: enum: - - ioss - - oss_non_union - - oss_union - - standard + - simplified type: string required: - type - title: europe + title: simplified type: object - hr: + kr: properties: - standard: - properties: - place_of_supply_scheme: - enum: - - small_seller - - standard - type: string - required: - - place_of_supply_scheme - title: standard - type: object type: enum: - - ioss - - oss_non_union - - oss_union - - standard + - simplified type: string required: - type - title: europe + title: simplified type: object - hu: + kz: + properties: + type: + enum: + - simplified + type: string + required: + - type + title: simplified + type: object + lt: properties: standard: properties: @@ -128467,17 +129677,7 @@ paths: - type title: europe type: object - id: - properties: - type: - enum: - - simplified - type: string - required: - - type - title: simplified - type: object - ie: + lu: properties: standard: properties: @@ -128501,17 +129701,7 @@ paths: - type title: europe type: object - is: - properties: - type: - enum: - - standard - type: string - required: - - type - title: default - type: object - it: + lv: properties: standard: properties: @@ -128535,27 +129725,7 @@ paths: - type title: europe type: object - jp: - properties: - type: - enum: - - standard - type: string - required: - - type - title: default - type: object - ke: - properties: - type: - enum: - - simplified - type: string - required: - - type - title: simplified - type: object - kr: + ma: properties: type: enum: @@ -128565,7 +129735,7 @@ paths: - type title: simplified type: object - kz: + md: properties: type: enum: @@ -128575,97 +129745,35 @@ paths: - type title: simplified type: object - lt: + me: properties: - standard: - properties: - place_of_supply_scheme: - enum: - - small_seller - - standard - type: string - required: - - place_of_supply_scheme - title: standard - type: object type: enum: - - ioss - - oss_non_union - - oss_union - standard type: string required: - type - title: europe + title: default type: object - lu: + mk: properties: - standard: - properties: - place_of_supply_scheme: - enum: - - small_seller - - standard - type: string - required: - - place_of_supply_scheme - title: standard - type: object type: enum: - - ioss - - oss_non_union - - oss_union - standard type: string required: - type - title: europe + title: default type: object - lv: + mr: properties: - standard: - properties: - place_of_supply_scheme: - enum: - - small_seller - - standard - type: string - required: - - place_of_supply_scheme - title: standard - type: object type: enum: - - ioss - - oss_non_union - - oss_union - standard type: string required: - type - title: europe - type: object - ma: - properties: - type: - enum: - - simplified - type: string - required: - - type - title: simplified - type: object - md: - properties: - type: - enum: - - simplified - type: string - required: - - type - title: simplified + title: default type: object mt: properties: @@ -128755,6 +129863,16 @@ paths: - type title: default type: object + np: + properties: + type: + enum: + - simplified + type: string + required: + - type + title: simplified + type: object nz: properties: type: @@ -128775,6 +129893,16 @@ paths: - type title: default type: object + pe: + properties: + type: + enum: + - simplified + type: string + required: + - type + title: simplified + type: object pl: properties: standard: @@ -128959,6 +130087,26 @@ paths: - type title: europe type: object + sn: + properties: + type: + enum: + - simplified + type: string + required: + - type + title: simplified + type: object + sr: + properties: + type: + enum: + - standard + type: string + required: + - type + title: default + type: object th: properties: type: @@ -128969,6 +130117,16 @@ paths: - type title: simplified type: object + tj: + properties: + type: + enum: + - simplified + type: string + required: + - type + title: simplified + type: object tr: properties: type: @@ -128989,6 +130147,16 @@ paths: - type title: simplified type: object + ug: + properties: + type: + enum: + - simplified + type: string + required: + - type + title: simplified + type: object us: properties: local_amusement_tax: @@ -129049,6 +130217,16 @@ paths: - type title: united_states type: object + uy: + properties: + type: + enum: + - standard + type: string + required: + - type + title: default + type: object uz: properties: type: @@ -129079,6 +130257,26 @@ paths: - type title: default type: object + zm: + properties: + type: + enum: + - simplified + type: string + required: + - type + title: simplified + type: object + zw: + properties: + type: + enum: + - standard + type: string + required: + - type + title: default + type: object title: country_options type: object expand: @@ -130071,32 +131269,41 @@ paths: type: object type: description: >- - Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, - `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, - `br_cpf`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, - `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, - `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, - `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, - `gb_vat`, `ge_vat`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, - `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, - `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `li_vat`, `ma_vat`, - `md_vat`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, - `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, - `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, - `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, - `tz_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, - `ve_rif`, `vn_tin`, or `za_vat` + Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, + `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `ba_tin`, + `bb_tin`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, + `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, + `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, + `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, + `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, + `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, + `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, + `jp_rn`, `jp_trn`, `ke_pin`, `kh_tin`, `kr_brn`, `kz_bin`, + `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, + `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, + `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, + `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, + `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, + `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, + `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, + `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin` enum: - ad_nrt - ae_trn + - al_tin + - am_tin + - ao_tin - ar_cuit - au_abn - au_arn + - ba_tin + - bb_tin - bg_uic - bh_vat - bo_tin - br_cnpj - br_cpf + - bs_tin - by_tin - ca_bn - ca_gst_hst @@ -130104,6 +131311,7 @@ paths: - ca_pst_mb - ca_pst_sk - ca_qst + - cd_nif - ch_uid - ch_vat - cl_tin @@ -130119,6 +131327,7 @@ paths: - eu_vat - gb_vat - ge_vat + - gn_nif - hk_br - hr_oib - hu_tin @@ -130130,12 +131339,16 @@ paths: - jp_rn - jp_trn - ke_pin + - kh_tin - kr_brn - kz_bin - li_uid - li_vat - ma_vat - md_vat + - me_pib + - mk_vat + - mr_nif - mx_rfc - my_frp - my_itn @@ -130143,6 +131356,7 @@ paths: - ng_tin - no_vat - no_voec + - np_pan - nz_gst - om_vat - pe_ruc @@ -130155,12 +131369,16 @@ paths: - sg_gst - sg_uen - si_tin + - sn_ninea + - sr_fin - sv_nit - th_vat + - tj_tin - tr_tin - tw_vat - tz_vat - ua_vat + - ug_tin - us_ein - uy_ruc - uz_tin @@ -130168,6 +131386,8 @@ paths: - ve_rif - vn_tin - za_vat + - zm_tin + - zw_tin maxLength: 5000 type: string x-stripeBypassValidation: true @@ -131986,11 +133206,10 @@ paths: properties: address: description: >- - The full address of the location. If you're updating the - `address` field, avoid changing the `country`. If you need - to modify the `country` field, create a new `Location` - object and re-register any existing readers to that - location. + The full address of the location. You can't change the + location's `country`. If you need to modify the `country` + field, create a new `Location` object and re-register any + existing readers to that location. properties: city: maxLength: 5000 @@ -132769,6 +133988,7 @@ paths: description: Cart properties: currency: + format: currency type: string line_items: items: @@ -133462,6 +134682,7 @@ paths: code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + format: currency type: string expand: description: Specifies which fields in the response should be expanded. @@ -133569,6 +134790,7 @@ paths: code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + format: currency type: string expand: description: Specifies which fields in the response should be expanded. @@ -133700,6 +134922,7 @@ paths: code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + format: currency type: string merchant_data: description: >- @@ -135181,6 +136404,7 @@ paths: code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + format: currency type: string expand: description: Specifies which fields in the response should be expanded. @@ -135271,6 +136495,7 @@ paths: code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + format: currency type: string expand: description: Specifies which fields in the response should be expanded. @@ -135845,6 +137070,7 @@ paths: code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + format: currency type: string expand: description: Specifies which fields in the response should be expanded. @@ -137530,6 +138756,7 @@ paths: code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + format: currency type: string description: description: >- @@ -137631,6 +138858,7 @@ paths: code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + format: currency type: string description: description: >- @@ -138168,6 +139396,7 @@ paths: maxLength: 5000 type: string currency: + format: currency type: string payment_method: maxLength: 5000 @@ -138509,6 +139738,8 @@ paths: type: object relationship: properties: + authorizer: + type: boolean director: type: boolean executive: @@ -139227,6 +140458,7 @@ paths: currency](https://www.iso.org/iso-4217-currency-codes.html) in lowercase. Must be a [supported currency](https://docs.stripe.com/currencies). + format: currency type: string description: description: >- @@ -141154,6 +142386,7 @@ paths: code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + format: currency type: string description: description: >- @@ -141499,6 +142732,7 @@ paths: code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + format: currency type: string customer: description: >- @@ -141587,6 +142821,7 @@ paths: - financial_account - us_bank_account type: string + x-stripeBypassValidation: true us_bank_account: properties: account_holder_type: @@ -141946,6 +143181,7 @@ paths: code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + format: currency type: string description: description: >- @@ -143186,6 +144422,8 @@ paths: - '2024-06-20' - 2024-09-30.acacia - 2024-10-28.acacia + - 2024-11-20.acacia + - 2024-12-18.acacia maxLength: 5000 type: string x-stripeBypassValidation: true diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 188cdada5..2fd76e3b4 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -54,8 +54,8 @@ importers: specifier: workspace:* version: link:../packages/openapi-metadata vite: - specifier: ^6.0.4 - version: 6.0.4(@types/node@22.10.2)(jiti@2.4.2)(yaml@2.5.1) + specifier: ^6.0.5 + version: 6.0.5(@types/node@22.10.2)(jiti@2.4.2)(yaml@2.5.1) vitepress: specifier: 1.5.0 version: 1.5.0(@algolia/client-search@5.18.0)(@types/node@22.10.2)(@types/react@18.3.12)(axios@1.7.8)(change-case@5.4.4)(postcss@8.4.49)(react-dom@18.3.1(react@18.3.1))(react@18.3.1)(search-insights@2.13.0)(typescript@5.7.2) @@ -173,28 +173,31 @@ importers: packages/openapi-fetch/examples/sveltekit: dependencies: + '@sveltejs/vite-plugin-svelte-inspector': + specifier: ^4.0.1 + version: 4.0.1(@sveltejs/vite-plugin-svelte@5.0.3(svelte@5.15.0)(vite@6.0.5(@types/node@22.10.2)(jiti@2.4.2)(yaml@2.5.1)))(svelte@5.15.0)(vite@6.0.5(@types/node@22.10.2)(jiti@2.4.2)(yaml@2.5.1)) openapi-fetch: specifier: workspace:^ version: link:../.. devDependencies: '@sveltejs/adapter-auto': specifier: ^3.3.1 - version: 3.3.1(@sveltejs/kit@2.9.0(@sveltejs/vite-plugin-svelte@3.1.2(svelte@4.2.19)(vite@6.0.4(@types/node@22.10.2)(jiti@2.4.2)(yaml@2.5.1)))(svelte@4.2.19)(vite@6.0.4(@types/node@22.10.2)(jiti@2.4.2)(yaml@2.5.1))) + version: 3.3.1(@sveltejs/kit@2.13.0(@sveltejs/vite-plugin-svelte@5.0.3(svelte@5.15.0)(vite@6.0.5(@types/node@22.10.2)(jiti@2.4.2)(yaml@2.5.1)))(svelte@5.15.0)(vite@6.0.5(@types/node@22.10.2)(jiti@2.4.2)(yaml@2.5.1))) '@sveltejs/kit': - specifier: ^2.9.0 - version: 2.9.0(@sveltejs/vite-plugin-svelte@3.1.2(svelte@4.2.19)(vite@6.0.4(@types/node@22.10.2)(jiti@2.4.2)(yaml@2.5.1)))(svelte@4.2.19)(vite@6.0.4(@types/node@22.10.2)(jiti@2.4.2)(yaml@2.5.1)) + specifier: ^2.13.0 + version: 2.13.0(@sveltejs/vite-plugin-svelte@5.0.3(svelte@5.15.0)(vite@6.0.5(@types/node@22.10.2)(jiti@2.4.2)(yaml@2.5.1)))(svelte@5.15.0)(vite@6.0.5(@types/node@22.10.2)(jiti@2.4.2)(yaml@2.5.1)) '@sveltejs/vite-plugin-svelte': - specifier: ^3.1.2 - version: 3.1.2(svelte@4.2.19)(vite@6.0.4(@types/node@22.10.2)(jiti@2.4.2)(yaml@2.5.1)) + specifier: ^5.0.3 + version: 5.0.3(svelte@5.15.0)(vite@6.0.5(@types/node@22.10.2)(jiti@2.4.2)(yaml@2.5.1)) openapi-typescript: specifier: workspace:^ version: link:../../../openapi-typescript svelte: - specifier: ^4.2.19 - version: 4.2.19 + specifier: ^5.15.0 + version: 5.15.0 svelte-check: specifier: ^3.8.6 - version: 3.8.6(@babel/core@7.26.0)(postcss@8.4.49)(svelte@4.2.19) + version: 3.8.6(@babel/core@7.26.0)(postcss@8.4.49)(svelte@5.15.0) tslib: specifier: ^2.8.1 version: 2.8.1 @@ -202,8 +205,8 @@ importers: specifier: ^5.7.2 version: 5.7.2 vite: - specifier: ^6.0.4 - version: 6.0.4(@types/node@22.10.2)(jiti@2.4.2)(yaml@2.5.1) + specifier: ^6.0.5 + version: 6.0.5(@types/node@22.10.2)(jiti@2.4.2)(yaml@2.5.1) packages/openapi-fetch/examples/vue-3: dependencies: @@ -252,8 +255,8 @@ importers: specifier: ^22.10.1 version: 22.10.1 '@vitest/coverage-v8': - specifier: ^2.1.6 - version: 2.1.6(vitest@2.1.8(@types/node@22.10.1)(jsdom@20.0.3)(msw@2.7.0(@types/node@22.10.1)(typescript@5.7.2))) + specifier: ^2.1.8 + version: 2.1.8(vitest@2.1.8(@types/node@22.10.1)(jsdom@20.0.3)(msw@2.7.0(@types/node@22.10.1)(typescript@5.7.2))) del-cli: specifier: ^5.1.0 version: 5.1.0 @@ -277,7 +280,7 @@ importers: version: 5.7.2 unplugin-swc: specifier: ^1.5.1 - version: 1.5.1(@swc/core@1.10.1(@swc/helpers@0.5.13))(rollup@4.28.1) + version: 1.5.1(@swc/core@1.10.1(@swc/helpers@0.5.13))(rollup@4.29.1) packages/openapi-react-query: dependencies: @@ -296,7 +299,7 @@ importers: version: 18.3.1 '@vitejs/plugin-react': specifier: ^4.3.4 - version: 4.3.4(vite@6.0.4(@types/node@22.10.2)(jiti@2.4.2)(yaml@2.5.1)) + version: 4.3.4(vite@6.0.5(@types/node@22.10.2)(jiti@2.4.2)(yaml@2.5.1)) del-cli: specifier: ^5.1.0 version: 5.1.0 @@ -787,6 +790,12 @@ packages: cpu: [ppc64] os: [aix] + '@esbuild/aix-ppc64@0.24.2': + resolution: {integrity: sha512-thpVCb/rhxE/BnMLQ7GReQLLN8q9qbHmI55F4489/ByVg2aQaQ6kbcLb6FHkocZzQhxc4gx0sCk0tJkKBFzDhA==} + engines: {node: '>=18'} + cpu: [ppc64] + os: [aix] + '@esbuild/android-arm64@0.21.5': resolution: {integrity: sha512-c0uX9VAUBQ7dTDCjq+wdyGLowMdtR/GoC2U5IYk/7D1H1JYC0qseD7+11iMP2mRLN9RcCMRcjC4YMclCzGwS/A==} engines: {node: '>=12'} @@ -799,6 +808,12 @@ packages: cpu: [arm64] os: [android] + '@esbuild/android-arm64@0.24.2': + resolution: {integrity: sha512-cNLgeqCqV8WxfcTIOeL4OAtSmL8JjcN6m09XIgro1Wi7cF4t/THaWEa7eL5CMoMBdjoHOTh/vwTO/o2TRXIyzg==} + engines: {node: '>=18'} + cpu: [arm64] + os: [android] + '@esbuild/android-arm@0.21.5': resolution: {integrity: sha512-vCPvzSjpPHEi1siZdlvAlsPxXl7WbOVUBBAowWug4rJHb68Ox8KualB+1ocNvT5fjv6wpkX6o/iEpbDrf68zcg==} engines: {node: '>=12'} @@ -811,6 +826,12 @@ packages: cpu: [arm] os: [android] + '@esbuild/android-arm@0.24.2': + resolution: {integrity: sha512-tmwl4hJkCfNHwFB3nBa8z1Uy3ypZpxqxfTQOcHX+xRByyYgunVbZ9MzUUfb0RxaHIMnbHagwAxuTL+tnNM+1/Q==} + engines: {node: '>=18'} + cpu: [arm] + os: [android] + '@esbuild/android-x64@0.21.5': resolution: {integrity: sha512-D7aPRUUNHRBwHxzxRvp856rjUHRFW1SdQATKXH2hqA0kAZb1hKmi02OpYRacl0TxIGz/ZmXWlbZgjwWYaCakTA==} engines: {node: '>=12'} @@ -823,6 +844,12 @@ packages: cpu: [x64] os: [android] + '@esbuild/android-x64@0.24.2': + resolution: {integrity: sha512-B6Q0YQDqMx9D7rvIcsXfmJfvUYLoP722bgfBlO5cGvNVb5V/+Y7nhBE3mHV9OpxBf4eAS2S68KZztiPaWq4XYw==} + engines: {node: '>=18'} + cpu: [x64] + os: [android] + '@esbuild/darwin-arm64@0.21.5': resolution: {integrity: sha512-DwqXqZyuk5AiWWf3UfLiRDJ5EDd49zg6O9wclZ7kUMv2WRFr4HKjXp/5t8JZ11QbQfUS6/cRCKGwYhtNAY88kQ==} engines: {node: '>=12'} @@ -835,6 +862,12 @@ packages: cpu: [arm64] os: [darwin] + '@esbuild/darwin-arm64@0.24.2': + resolution: {integrity: sha512-kj3AnYWc+CekmZnS5IPu9D+HWtUI49hbnyqk0FLEJDbzCIQt7hg7ucF1SQAilhtYpIujfaHr6O0UHlzzSPdOeA==} + engines: {node: '>=18'} + cpu: [arm64] + os: [darwin] + '@esbuild/darwin-x64@0.21.5': resolution: {integrity: sha512-se/JjF8NlmKVG4kNIuyWMV/22ZaerB+qaSi5MdrXtd6R08kvs2qCN4C09miupktDitvh8jRFflwGFBQcxZRjbw==} engines: {node: '>=12'} @@ -847,6 +880,12 @@ packages: cpu: [x64] os: [darwin] + '@esbuild/darwin-x64@0.24.2': + resolution: {integrity: sha512-WeSrmwwHaPkNR5H3yYfowhZcbriGqooyu3zI/3GGpF8AyUdsrrP0X6KumITGA9WOyiJavnGZUwPGvxvwfWPHIA==} + engines: {node: '>=18'} + cpu: [x64] + os: [darwin] + '@esbuild/freebsd-arm64@0.21.5': resolution: {integrity: sha512-5JcRxxRDUJLX8JXp/wcBCy3pENnCgBR9bN6JsY4OmhfUtIHe3ZW0mawA7+RDAcMLrMIZaf03NlQiX9DGyB8h4g==} engines: {node: '>=12'} @@ -859,6 +898,12 @@ packages: cpu: [arm64] os: [freebsd] + '@esbuild/freebsd-arm64@0.24.2': + resolution: {integrity: sha512-UN8HXjtJ0k/Mj6a9+5u6+2eZ2ERD7Edt1Q9IZiB5UZAIdPnVKDoG7mdTVGhHJIeEml60JteamR3qhsr1r8gXvg==} + engines: {node: '>=18'} + cpu: [arm64] + os: [freebsd] + '@esbuild/freebsd-x64@0.21.5': resolution: {integrity: sha512-J95kNBj1zkbMXtHVH29bBriQygMXqoVQOQYA+ISs0/2l3T9/kj42ow2mpqerRBxDJnmkUDCaQT/dfNXWX/ZZCQ==} engines: {node: '>=12'} @@ -871,6 +916,12 @@ packages: cpu: [x64] os: [freebsd] + '@esbuild/freebsd-x64@0.24.2': + resolution: {integrity: sha512-TvW7wE/89PYW+IevEJXZ5sF6gJRDY/14hyIGFXdIucxCsbRmLUcjseQu1SyTko+2idmCw94TgyaEZi9HUSOe3Q==} + engines: {node: '>=18'} + cpu: [x64] + os: [freebsd] + '@esbuild/linux-arm64@0.21.5': resolution: {integrity: sha512-ibKvmyYzKsBeX8d8I7MH/TMfWDXBF3db4qM6sy+7re0YXya+K1cem3on9XgdT2EQGMu4hQyZhan7TeQ8XkGp4Q==} engines: {node: '>=12'} @@ -883,6 +934,12 @@ packages: cpu: [arm64] os: [linux] + '@esbuild/linux-arm64@0.24.2': + resolution: {integrity: sha512-7HnAD6074BW43YvvUmE/35Id9/NB7BeX5EoNkK9obndmZBUk8xmJJeU7DwmUeN7tkysslb2eSl6CTrYz6oEMQg==} + engines: {node: '>=18'} + cpu: [arm64] + os: [linux] + '@esbuild/linux-arm@0.21.5': resolution: {integrity: sha512-bPb5AHZtbeNGjCKVZ9UGqGwo8EUu4cLq68E95A53KlxAPRmUyYv2D6F0uUI65XisGOL1hBP5mTronbgo+0bFcA==} engines: {node: '>=12'} @@ -895,6 +952,12 @@ packages: cpu: [arm] os: [linux] + '@esbuild/linux-arm@0.24.2': + resolution: {integrity: sha512-n0WRM/gWIdU29J57hJyUdIsk0WarGd6To0s+Y+LwvlC55wt+GT/OgkwoXCXvIue1i1sSNWblHEig00GBWiJgfA==} + engines: {node: '>=18'} + cpu: [arm] + os: [linux] + '@esbuild/linux-ia32@0.21.5': resolution: {integrity: sha512-YvjXDqLRqPDl2dvRODYmmhz4rPeVKYvppfGYKSNGdyZkA01046pLWyRKKI3ax8fbJoK5QbxblURkwK/MWY18Tg==} engines: {node: '>=12'} @@ -907,6 +970,12 @@ packages: cpu: [ia32] os: [linux] + '@esbuild/linux-ia32@0.24.2': + resolution: {integrity: sha512-sfv0tGPQhcZOgTKO3oBE9xpHuUqguHvSo4jl+wjnKwFpapx+vUDcawbwPNuBIAYdRAvIDBfZVvXprIj3HA+Ugw==} + engines: {node: '>=18'} + cpu: [ia32] + os: [linux] + '@esbuild/linux-loong64@0.21.5': resolution: {integrity: sha512-uHf1BmMG8qEvzdrzAqg2SIG/02+4/DHB6a9Kbya0XDvwDEKCoC8ZRWI5JJvNdUjtciBGFQ5PuBlpEOXQj+JQSg==} engines: {node: '>=12'} @@ -919,6 +988,12 @@ packages: cpu: [loong64] os: [linux] + '@esbuild/linux-loong64@0.24.2': + resolution: {integrity: sha512-CN9AZr8kEndGooS35ntToZLTQLHEjtVB5n7dl8ZcTZMonJ7CCfStrYhrzF97eAecqVbVJ7APOEe18RPI4KLhwQ==} + engines: {node: '>=18'} + cpu: [loong64] + os: [linux] + '@esbuild/linux-mips64el@0.21.5': resolution: {integrity: sha512-IajOmO+KJK23bj52dFSNCMsz1QP1DqM6cwLUv3W1QwyxkyIWecfafnI555fvSGqEKwjMXVLokcV5ygHW5b3Jbg==} engines: {node: '>=12'} @@ -931,6 +1006,12 @@ packages: cpu: [mips64el] os: [linux] + '@esbuild/linux-mips64el@0.24.2': + resolution: {integrity: sha512-iMkk7qr/wl3exJATwkISxI7kTcmHKE+BlymIAbHO8xanq/TjHaaVThFF6ipWzPHryoFsesNQJPE/3wFJw4+huw==} + engines: {node: '>=18'} + cpu: [mips64el] + os: [linux] + '@esbuild/linux-ppc64@0.21.5': resolution: {integrity: sha512-1hHV/Z4OEfMwpLO8rp7CvlhBDnjsC3CttJXIhBi+5Aj5r+MBvy4egg7wCbe//hSsT+RvDAG7s81tAvpL2XAE4w==} engines: {node: '>=12'} @@ -943,6 +1024,12 @@ packages: cpu: [ppc64] os: [linux] + '@esbuild/linux-ppc64@0.24.2': + resolution: {integrity: sha512-shsVrgCZ57Vr2L8mm39kO5PPIb+843FStGt7sGGoqiiWYconSxwTiuswC1VJZLCjNiMLAMh34jg4VSEQb+iEbw==} + engines: {node: '>=18'} + cpu: [ppc64] + os: [linux] + '@esbuild/linux-riscv64@0.21.5': resolution: {integrity: sha512-2HdXDMd9GMgTGrPWnJzP2ALSokE/0O5HhTUvWIbD3YdjME8JwvSCnNGBnTThKGEB91OZhzrJ4qIIxk/SBmyDDA==} engines: {node: '>=12'} @@ -955,6 +1042,12 @@ packages: cpu: [riscv64] os: [linux] + '@esbuild/linux-riscv64@0.24.2': + resolution: {integrity: sha512-4eSFWnU9Hhd68fW16GD0TINewo1L6dRrB+oLNNbYyMUAeOD2yCK5KXGK1GH4qD/kT+bTEXjsyTCiJGHPZ3eM9Q==} + engines: {node: '>=18'} + cpu: [riscv64] + os: [linux] + '@esbuild/linux-s390x@0.21.5': resolution: {integrity: sha512-zus5sxzqBJD3eXxwvjN1yQkRepANgxE9lgOW2qLnmr8ikMTphkjgXu1HR01K4FJg8h1kEEDAqDcZQtbrRnB41A==} engines: {node: '>=12'} @@ -967,6 +1060,12 @@ packages: cpu: [s390x] os: [linux] + '@esbuild/linux-s390x@0.24.2': + resolution: {integrity: sha512-S0Bh0A53b0YHL2XEXC20bHLuGMOhFDO6GN4b3YjRLK//Ep3ql3erpNcPlEFed93hsQAjAQDNsvcK+hV90FubSw==} + engines: {node: '>=18'} + cpu: [s390x] + os: [linux] + '@esbuild/linux-x64@0.21.5': resolution: {integrity: sha512-1rYdTpyv03iycF1+BhzrzQJCdOuAOtaqHTWJZCWvijKD2N5Xu0TtVC8/+1faWqcP9iBCWOmjmhoH94dH82BxPQ==} engines: {node: '>=12'} @@ -979,6 +1078,18 @@ packages: cpu: [x64] os: [linux] + '@esbuild/linux-x64@0.24.2': + resolution: {integrity: sha512-8Qi4nQcCTbLnK9WoMjdC9NiTG6/E38RNICU6sUNqK0QFxCYgoARqVqxdFmWkdonVsvGqWhmm7MO0jyTqLqwj0Q==} + engines: {node: '>=18'} + cpu: [x64] + os: [linux] + + '@esbuild/netbsd-arm64@0.24.2': + resolution: {integrity: sha512-wuLK/VztRRpMt9zyHSazyCVdCXlpHkKm34WUyinD2lzK07FAHTq0KQvZZlXikNWkDGoT6x3TD51jKQ7gMVpopw==} + engines: {node: '>=18'} + cpu: [arm64] + os: [netbsd] + '@esbuild/netbsd-x64@0.21.5': resolution: {integrity: sha512-Woi2MXzXjMULccIwMnLciyZH4nCIMpWQAs049KEeMvOcNADVxo0UBIQPfSmxB3CWKedngg7sWZdLvLczpe0tLg==} engines: {node: '>=12'} @@ -991,12 +1102,24 @@ packages: cpu: [x64] os: [netbsd] + '@esbuild/netbsd-x64@0.24.2': + resolution: {integrity: sha512-VefFaQUc4FMmJuAxmIHgUmfNiLXY438XrL4GDNV1Y1H/RW3qow68xTwjZKfj/+Plp9NANmzbH5R40Meudu8mmw==} + engines: {node: '>=18'} + cpu: [x64] + os: [netbsd] + '@esbuild/openbsd-arm64@0.24.0': resolution: {integrity: sha512-MD9uzzkPQbYehwcN583yx3Tu5M8EIoTD+tUgKF982WYL9Pf5rKy9ltgD0eUgs8pvKnmizxjXZyLt0z6DC3rRXg==} engines: {node: '>=18'} cpu: [arm64] os: [openbsd] + '@esbuild/openbsd-arm64@0.24.2': + resolution: {integrity: sha512-YQbi46SBct6iKnszhSvdluqDmxCJA+Pu280Av9WICNwQmMxV7nLRHZfjQzwbPs3jeWnuAhE9Jy0NrnJ12Oz+0A==} + engines: {node: '>=18'} + cpu: [arm64] + os: [openbsd] + '@esbuild/openbsd-x64@0.21.5': resolution: {integrity: sha512-HLNNw99xsvx12lFBUwoT8EVCsSvRNDVxNpjZ7bPn947b8gJPzeHWyNVhFsaerc0n3TsbOINvRP2byTZ5LKezow==} engines: {node: '>=12'} @@ -1009,6 +1132,12 @@ packages: cpu: [x64] os: [openbsd] + '@esbuild/openbsd-x64@0.24.2': + resolution: {integrity: sha512-+iDS6zpNM6EnJyWv0bMGLWSWeXGN/HTaF/LXHXHwejGsVi+ooqDfMCCTerNFxEkM3wYVcExkeGXNqshc9iMaOA==} + engines: {node: '>=18'} + cpu: [x64] + os: [openbsd] + '@esbuild/sunos-x64@0.21.5': resolution: {integrity: sha512-6+gjmFpfy0BHU5Tpptkuh8+uw3mnrvgs+dSPQXQOv3ekbordwnzTVEb4qnIvQcYXq6gzkyTnoZ9dZG+D4garKg==} engines: {node: '>=12'} @@ -1021,6 +1150,12 @@ packages: cpu: [x64] os: [sunos] + '@esbuild/sunos-x64@0.24.2': + resolution: {integrity: sha512-hTdsW27jcktEvpwNHJU4ZwWFGkz2zRJUz8pvddmXPtXDzVKTTINmlmga3ZzwcuMpUvLw7JkLy9QLKyGpD2Yxig==} + engines: {node: '>=18'} + cpu: [x64] + os: [sunos] + '@esbuild/win32-arm64@0.21.5': resolution: {integrity: sha512-Z0gOTd75VvXqyq7nsl93zwahcTROgqvuAcYDUr+vOv8uHhNSKROyU961kgtCD1e95IqPKSQKH7tBTslnS3tA8A==} engines: {node: '>=12'} @@ -1033,6 +1168,12 @@ packages: cpu: [arm64] os: [win32] + '@esbuild/win32-arm64@0.24.2': + resolution: {integrity: sha512-LihEQ2BBKVFLOC9ZItT9iFprsE9tqjDjnbulhHoFxYQtQfai7qfluVODIYxt1PgdoyQkz23+01rzwNwYfutxUQ==} + engines: {node: '>=18'} + cpu: [arm64] + os: [win32] + '@esbuild/win32-ia32@0.21.5': resolution: {integrity: sha512-SWXFF1CL2RVNMaVs+BBClwtfZSvDgtL//G/smwAc5oVK/UPu2Gu9tIaRgFmYFFKrmg3SyAjSrElf0TiJ1v8fYA==} engines: {node: '>=12'} @@ -1045,6 +1186,12 @@ packages: cpu: [ia32] os: [win32] + '@esbuild/win32-ia32@0.24.2': + resolution: {integrity: sha512-q+iGUwfs8tncmFC9pcnD5IvRHAzmbwQ3GPS5/ceCyHdjXubwQWI12MKWSNSMYLJMq23/IUCvJMS76PDqXe1fxA==} + engines: {node: '>=18'} + cpu: [ia32] + os: [win32] + '@esbuild/win32-x64@0.21.5': resolution: {integrity: sha512-tQd/1efJuzPC6rCFwEvLtci/xNFcTZknmXs98FYDfGE4wP9ClFV98nyKrzJKVPMhdDnjzLhdUyMX4PsQAPjwIw==} engines: {node: '>=12'} @@ -1057,6 +1204,12 @@ packages: cpu: [x64] os: [win32] + '@esbuild/win32-x64@0.24.2': + resolution: {integrity: sha512-7VTgWzgMGvup6aSqDPLiW5zHaxYJGTO4OokMjIlrCtf+VpEL+cXKtCvg723iguPYI5oaUNdS+/V7OU2gvXVWEg==} + engines: {node: '>=18'} + cpu: [x64] + os: [win32] + '@floating-ui/core@1.6.8': resolution: {integrity: sha512-7XJ9cPU+yI2QeLS+FCSlqNFZJq8arvswefkZrYI1yQBbftw6FyrZOxYSh+9S7z7TpeWlRt9zJ5IhM1WIL334jA==} @@ -1353,6 +1506,11 @@ packages: cpu: [arm] os: [android] + '@rollup/rollup-android-arm-eabi@4.29.1': + resolution: {integrity: sha512-ssKhA8RNltTZLpG6/QNkCSge+7mBQGUqJRisZ2MDQcEGaK93QESEgWK2iOpIDZ7k9zPVkG5AS3ksvD5ZWxmItw==} + cpu: [arm] + os: [android] + '@rollup/rollup-android-arm64@4.28.0': resolution: {integrity: sha512-eiNkznlo0dLmVG/6wf+Ifi/v78G4d4QxRhuUl+s8EWZpDewgk7PX3ZyECUXU0Zq/Ca+8nU8cQpNC4Xgn2gFNDA==} cpu: [arm64] @@ -1363,6 +1521,11 @@ packages: cpu: [arm64] os: [android] + '@rollup/rollup-android-arm64@4.29.1': + resolution: {integrity: sha512-CaRfrV0cd+NIIcVVN/jx+hVLN+VRqnuzLRmfmlzpOzB87ajixsN/+9L5xNmkaUUvEbI5BmIKS+XTwXsHEb65Ew==} + cpu: [arm64] + os: [android] + '@rollup/rollup-darwin-arm64@4.28.0': resolution: {integrity: sha512-lmKx9yHsppblnLQZOGxdO66gT77bvdBtr/0P+TPOseowE7D9AJoBw8ZDULRasXRWf1Z86/gcOdpBrV6VDUY36Q==} cpu: [arm64] @@ -1373,6 +1536,11 @@ packages: cpu: [arm64] os: [darwin] + '@rollup/rollup-darwin-arm64@4.29.1': + resolution: {integrity: sha512-2ORr7T31Y0Mnk6qNuwtyNmy14MunTAMx06VAPI6/Ju52W10zk1i7i5U3vlDRWjhOI5quBcrvhkCHyF76bI7kEw==} + cpu: [arm64] + os: [darwin] + '@rollup/rollup-darwin-x64@4.28.0': resolution: {integrity: sha512-8hxgfReVs7k9Js1uAIhS6zq3I+wKQETInnWQtgzt8JfGx51R1N6DRVy3F4o0lQwumbErRz52YqwjfvuwRxGv1w==} cpu: [x64] @@ -1383,6 +1551,11 @@ packages: cpu: [x64] os: [darwin] + '@rollup/rollup-darwin-x64@4.29.1': + resolution: {integrity: sha512-j/Ej1oanzPjmN0tirRd5K2/nncAhS9W6ICzgxV+9Y5ZsP0hiGhHJXZ2JQ53iSSjj8m6cRY6oB1GMzNn2EUt6Ng==} + cpu: [x64] + os: [darwin] + '@rollup/rollup-freebsd-arm64@4.28.0': resolution: {integrity: sha512-lA1zZB3bFx5oxu9fYud4+g1mt+lYXCoch0M0V/xhqLoGatbzVse0wlSQ1UYOWKpuSu3gyN4qEc0Dxf/DII1bhQ==} cpu: [arm64] @@ -1393,6 +1566,11 @@ packages: cpu: [arm64] os: [freebsd] + '@rollup/rollup-freebsd-arm64@4.29.1': + resolution: {integrity: sha512-91C//G6Dm/cv724tpt7nTyP+JdN12iqeXGFM1SqnljCmi5yTXriH7B1r8AD9dAZByHpKAumqP1Qy2vVNIdLZqw==} + cpu: [arm64] + os: [freebsd] + '@rollup/rollup-freebsd-x64@4.28.0': resolution: {integrity: sha512-aI2plavbUDjCQB/sRbeUZWX9qp12GfYkYSJOrdYTL/C5D53bsE2/nBPuoiJKoWp5SN78v2Vr8ZPnB+/VbQ2pFA==} cpu: [x64] @@ -1403,6 +1581,11 @@ packages: cpu: [x64] os: [freebsd] + '@rollup/rollup-freebsd-x64@4.29.1': + resolution: {integrity: sha512-hEioiEQ9Dec2nIRoeHUP6hr1PSkXzQaCUyqBDQ9I9ik4gCXQZjJMIVzoNLBRGet+hIUb3CISMh9KXuCcWVW/8w==} + cpu: [x64] + os: [freebsd] + '@rollup/rollup-linux-arm-gnueabihf@4.28.0': resolution: {integrity: sha512-WXveUPKtfqtaNvpf0iOb0M6xC64GzUX/OowbqfiCSXTdi/jLlOmH0Ba94/OkiY2yTGTwteo4/dsHRfh5bDCZ+w==} cpu: [arm] @@ -1413,6 +1596,11 @@ packages: cpu: [arm] os: [linux] + '@rollup/rollup-linux-arm-gnueabihf@4.29.1': + resolution: {integrity: sha512-Py5vFd5HWYN9zxBv3WMrLAXY3yYJ6Q/aVERoeUFwiDGiMOWsMs7FokXihSOaT/PMWUty/Pj60XDQndK3eAfE6A==} + cpu: [arm] + os: [linux] + '@rollup/rollup-linux-arm-musleabihf@4.28.0': resolution: {integrity: sha512-yLc3O2NtOQR67lI79zsSc7lk31xjwcaocvdD1twL64PK1yNaIqCeWI9L5B4MFPAVGEVjH5k1oWSGuYX1Wutxpg==} cpu: [arm] @@ -1423,6 +1611,11 @@ packages: cpu: [arm] os: [linux] + '@rollup/rollup-linux-arm-musleabihf@4.29.1': + resolution: {integrity: sha512-RiWpGgbayf7LUcuSNIbahr0ys2YnEERD4gYdISA06wa0i8RALrnzflh9Wxii7zQJEB2/Eh74dX4y/sHKLWp5uQ==} + cpu: [arm] + os: [linux] + '@rollup/rollup-linux-arm64-gnu@4.28.0': resolution: {integrity: sha512-+P9G9hjEpHucHRXqesY+3X9hD2wh0iNnJXX/QhS/J5vTdG6VhNYMxJ2rJkQOxRUd17u5mbMLHM7yWGZdAASfcg==} cpu: [arm64] @@ -1433,6 +1626,11 @@ packages: cpu: [arm64] os: [linux] + '@rollup/rollup-linux-arm64-gnu@4.29.1': + resolution: {integrity: sha512-Z80O+taYxTQITWMjm/YqNoe9d10OX6kDh8X5/rFCMuPqsKsSyDilvfg+vd3iXIqtfmp+cnfL1UrYirkaF8SBZA==} + cpu: [arm64] + os: [linux] + '@rollup/rollup-linux-arm64-musl@4.28.0': resolution: {integrity: sha512-1xsm2rCKSTpKzi5/ypT5wfc+4bOGa/9yI/eaOLW0oMs7qpC542APWhl4A37AENGZ6St6GBMWhCCMM6tXgTIplw==} cpu: [arm64] @@ -1443,11 +1641,21 @@ packages: cpu: [arm64] os: [linux] + '@rollup/rollup-linux-arm64-musl@4.29.1': + resolution: {integrity: sha512-fOHRtF9gahwJk3QVp01a/GqS4hBEZCV1oKglVVq13kcK3NeVlS4BwIFzOHDbmKzt3i0OuHG4zfRP0YoG5OF/rA==} + cpu: [arm64] + os: [linux] + '@rollup/rollup-linux-loongarch64-gnu@4.28.1': resolution: {integrity: sha512-vPul4uodvWvLhRco2w0GcyZcdyBfpfDRgNKU+p35AWEbJ/HPs1tOUrkSueVbBS0RQHAf/A+nNtDpvw95PeVKOA==} cpu: [loong64] os: [linux] + '@rollup/rollup-linux-loongarch64-gnu@4.29.1': + resolution: {integrity: sha512-5a7q3tnlbcg0OodyxcAdrrCxFi0DgXJSoOuidFUzHZ2GixZXQs6Tc3CHmlvqKAmOs5eRde+JJxeIf9DonkmYkw==} + cpu: [loong64] + os: [linux] + '@rollup/rollup-linux-powerpc64le-gnu@4.28.0': resolution: {integrity: sha512-zgWxMq8neVQeXL+ouSf6S7DoNeo6EPgi1eeqHXVKQxqPy1B2NvTbaOUWPn/7CfMKL7xvhV0/+fq/Z/J69g1WAQ==} cpu: [ppc64] @@ -1458,6 +1666,11 @@ packages: cpu: [ppc64] os: [linux] + '@rollup/rollup-linux-powerpc64le-gnu@4.29.1': + resolution: {integrity: sha512-9b4Mg5Yfz6mRnlSPIdROcfw1BU22FQxmfjlp/CShWwO3LilKQuMISMTtAu/bxmmrE6A902W2cZJuzx8+gJ8e9w==} + cpu: [ppc64] + os: [linux] + '@rollup/rollup-linux-riscv64-gnu@4.28.0': resolution: {integrity: sha512-VEdVYacLniRxbRJLNtzwGt5vwS0ycYshofI7cWAfj7Vg5asqj+pt+Q6x4n+AONSZW/kVm+5nklde0qs2EUwU2g==} cpu: [riscv64] @@ -1468,6 +1681,11 @@ packages: cpu: [riscv64] os: [linux] + '@rollup/rollup-linux-riscv64-gnu@4.29.1': + resolution: {integrity: sha512-G5pn0NChlbRM8OJWpJFMX4/i8OEU538uiSv0P6roZcbpe/WfhEO+AT8SHVKfp8qhDQzaz7Q+1/ixMy7hBRidnQ==} + cpu: [riscv64] + os: [linux] + '@rollup/rollup-linux-s390x-gnu@4.28.0': resolution: {integrity: sha512-LQlP5t2hcDJh8HV8RELD9/xlYtEzJkm/aWGsauvdO2ulfl3QYRjqrKW+mGAIWP5kdNCBheqqqYIGElSRCaXfpw==} cpu: [s390x] @@ -1478,6 +1696,11 @@ packages: cpu: [s390x] os: [linux] + '@rollup/rollup-linux-s390x-gnu@4.29.1': + resolution: {integrity: sha512-WM9lIkNdkhVwiArmLxFXpWndFGuOka4oJOZh8EP3Vb8q5lzdSCBuhjavJsw68Q9AKDGeOOIHYzYm4ZFvmWez5g==} + cpu: [s390x] + os: [linux] + '@rollup/rollup-linux-x64-gnu@4.28.0': resolution: {integrity: sha512-Nl4KIzteVEKE9BdAvYoTkW19pa7LR/RBrT6F1dJCV/3pbjwDcaOq+edkP0LXuJ9kflW/xOK414X78r+K84+msw==} cpu: [x64] @@ -1488,6 +1711,11 @@ packages: cpu: [x64] os: [linux] + '@rollup/rollup-linux-x64-gnu@4.29.1': + resolution: {integrity: sha512-87xYCwb0cPGZFoGiErT1eDcssByaLX4fc0z2nRM6eMtV9njAfEE6OW3UniAoDhX4Iq5xQVpE6qO9aJbCFumKYQ==} + cpu: [x64] + os: [linux] + '@rollup/rollup-linux-x64-musl@4.28.0': resolution: {integrity: sha512-eKpJr4vBDOi4goT75MvW+0dXcNUqisK4jvibY9vDdlgLx+yekxSm55StsHbxUsRxSTt3JEQvlr3cGDkzcSP8bw==} cpu: [x64] @@ -1498,6 +1726,11 @@ packages: cpu: [x64] os: [linux] + '@rollup/rollup-linux-x64-musl@4.29.1': + resolution: {integrity: sha512-xufkSNppNOdVRCEC4WKvlR1FBDyqCSCpQeMMgv9ZyXqqtKBfkw1yfGMTUTs9Qsl6WQbJnsGboWCp7pJGkeMhKA==} + cpu: [x64] + os: [linux] + '@rollup/rollup-win32-arm64-msvc@4.28.0': resolution: {integrity: sha512-Vi+WR62xWGsE/Oj+mD0FNAPY2MEox3cfyG0zLpotZdehPFXwz6lypkGs5y38Jd/NVSbOD02aVad6q6QYF7i8Bg==} cpu: [arm64] @@ -1508,6 +1741,11 @@ packages: cpu: [arm64] os: [win32] + '@rollup/rollup-win32-arm64-msvc@4.29.1': + resolution: {integrity: sha512-F2OiJ42m77lSkizZQLuC+jiZ2cgueWQL5YC9tjo3AgaEw+KJmVxHGSyQfDUoYR9cci0lAywv2Clmckzulcq6ig==} + cpu: [arm64] + os: [win32] + '@rollup/rollup-win32-ia32-msvc@4.28.0': resolution: {integrity: sha512-kN/Vpip8emMLn/eOza+4JwqDZBL6MPNpkdaEsgUtW1NYN3DZvZqSQrbKzJcTL6hd8YNmFTn7XGWMwccOcJBL0A==} cpu: [ia32] @@ -1518,6 +1756,11 @@ packages: cpu: [ia32] os: [win32] + '@rollup/rollup-win32-ia32-msvc@4.29.1': + resolution: {integrity: sha512-rYRe5S0FcjlOBZQHgbTKNrqxCBUmgDJem/VQTCcTnA2KCabYSWQDrytOzX7avb79cAAweNmMUb/Zw18RNd4mng==} + cpu: [ia32] + os: [win32] + '@rollup/rollup-win32-x64-msvc@4.28.0': resolution: {integrity: sha512-Bvno2/aZT6usSa7lRDL2+hMjVAGjuqaymF1ApZm31JXzniR/hvr14jpU+/z4X6Gt5BPlzosscyJZGUvguXIqeQ==} cpu: [x64] @@ -1528,6 +1771,11 @@ packages: cpu: [x64] os: [win32] + '@rollup/rollup-win32-x64-msvc@4.29.1': + resolution: {integrity: sha512-+10CMg9vt1MoHj6x1pxyjPSMjHTIlqs8/tBztXvPAx24SKs9jwVnKqHJumlH/IzhaPUaj3T6T6wfZr8okdXaIg==} + cpu: [x64] + os: [win32] + '@shikijs/core@1.24.3': resolution: {integrity: sha512-VRcf4GYUIkxIchGM9DrapRcxtgojg4IWKUtX5EtW+4PJiGzF2xQqZSv27PJt+WLc18KT3CNLpNWow9JYV5n+Rg==} @@ -1578,8 +1826,8 @@ packages: peerDependencies: '@sveltejs/kit': ^2.0.0 - '@sveltejs/kit@2.9.0': - resolution: {integrity: sha512-W3E7ed3ChB6kPqRs2H7tcHp+Z7oiTFC6m+lLyAQQuyXeqw6LdNuuwEUla+5VM0OGgqQD+cYD6+7Xq80vVm17Vg==} + '@sveltejs/kit@2.13.0': + resolution: {integrity: sha512-6t6ne00vZx/TjD6s0Jvwt8wRLKBwbSAN1nhlOzcLUSTYX1hTp4eCBaTPB5Yz/lu+tYcvz4YPEEuPv3yfsNp2gw==} engines: {node: '>=18.13'} hasBin: true peerDependencies: @@ -1587,20 +1835,20 @@ packages: svelte: ^4.0.0 || ^5.0.0-next.0 vite: ^5.0.3 || ^6.0.0 - '@sveltejs/vite-plugin-svelte-inspector@2.1.0': - resolution: {integrity: sha512-9QX28IymvBlSCqsCll5t0kQVxipsfhFFL+L2t3nTWfXnddYwxBuAEtTtlaVQpRz9c37BhJjltSeY4AJSC03SSg==} - engines: {node: ^18.0.0 || >=20} + '@sveltejs/vite-plugin-svelte-inspector@4.0.1': + resolution: {integrity: sha512-J/Nmb2Q2y7mck2hyCX4ckVHcR5tu2J+MtBEQqpDrrgELZ2uvraQcK/ioCV61AqkdXFgriksOKIceDcQmqnGhVw==} + engines: {node: ^18.0.0 || ^20.0.0 || >=22} peerDependencies: - '@sveltejs/vite-plugin-svelte': ^3.0.0 - svelte: ^4.0.0 || ^5.0.0-next.0 - vite: ^5.0.0 + '@sveltejs/vite-plugin-svelte': ^5.0.0 + svelte: ^5.0.0 + vite: ^6.0.0 - '@sveltejs/vite-plugin-svelte@3.1.2': - resolution: {integrity: sha512-Txsm1tJvtiYeLUVRNqxZGKR/mI+CzuIQuc2gn+YCs9rMTowpNZ2Nqt53JdL8KF9bLhAf2ruR/dr9eZCwdTriRA==} - engines: {node: ^18.0.0 || >=20} + '@sveltejs/vite-plugin-svelte@5.0.3': + resolution: {integrity: sha512-MCFS6CrQDu1yGwspm4qtli0e63vaPCehf6V7pIMP15AsWgMKrqDGCPFF/0kn4SP0ii4aySu4Pa62+fIRGFMjgw==} + engines: {node: ^18.0.0 || ^20.0.0 || >=22} peerDependencies: - svelte: ^4.0.0 || ^5.0.0-next.0 - vite: ^5.0.0 + svelte: ^5.0.0 + vite: ^6.0.0 '@swc/core-darwin-arm64@1.10.1': resolution: {integrity: sha512-NyELPp8EsVZtxH/mEqvzSyWpfPJ1lugpTQcSlMduZLj1EASLO4sC8wt8hmL1aizRlsbjCX+r0PyL+l0xQ64/6Q==} @@ -1845,11 +2093,11 @@ packages: vite: ^5.0.0 || ^6.0.0 vue: ^3.2.25 - '@vitest/coverage-v8@2.1.6': - resolution: {integrity: sha512-qItJVYDbG3MUFO68dOZUz+rWlqe9LMzotERXFXKg25s2A/kSVsyS9O0yNGrITfBd943GsnBeQZkBUu7Pc+zVeA==} + '@vitest/coverage-v8@2.1.8': + resolution: {integrity: sha512-2Y7BPlKH18mAZYAW1tYByudlCYrQyl5RGvnnDYJKW5tCiO5qg3KSAy3XAxcxKz900a0ZXxWtKrMuZLe3lKBpJw==} peerDependencies: - '@vitest/browser': 2.1.6 - vitest: 2.1.6 + '@vitest/browser': 2.1.8 + vitest: 2.1.8 peerDependenciesMeta: '@vitest/browser': optional: true @@ -2048,6 +2296,11 @@ packages: acorn-globals@7.0.1: resolution: {integrity: sha512-umOSDSDrfHbTNPuNpC2NSnnA3LUrqpevPb4T9jRx4MagXNS0rs+gwiTcAvqCRmsD6utzsrzNt+ebm00SNWiC3Q==} + acorn-typescript@1.4.13: + resolution: {integrity: sha512-xsc9Xv0xlVfwp2o7sQ+GCQ1PgbkdcpWdTzrwXxO3xDMTAywVS3oXVOcOHuRjAPkS4P9b+yc/qNF15460v+jp4Q==} + peerDependencies: + acorn: '>=8.9.0' + acorn-walk@8.3.4: resolution: {integrity: sha512-ueEepnujpqee2o5aIYnvHU6C0A42MNdsIDeqy5BydrkuC5R1ZuUFnm27EeFJGoEHJQgn3uleRvmTXaJgfXbt4g==} engines: {node: '>=0.4.0'} @@ -2328,9 +2581,6 @@ packages: resolution: {integrity: sha512-BSeNnyus75C4//NQ9gQt1/csTXyo/8Sb+afLAkzAptFuMsod9HFokGNudZpi/oQV73hnVK+sR+5PVRMd+Dr7YQ==} engines: {node: '>=12'} - code-red@1.0.4: - resolution: {integrity: sha512-7qJWqItLA8/VPVlKJlFXU+NBlo/qyfs39aJcuMT/2ere32ZqvF5OSxgdM5xOfJJ7O429gg2HM47y8v9P+9wrNw==} - color-convert@2.0.1: resolution: {integrity: sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==} engines: {node: '>=7.0.0'} @@ -2428,10 +2678,6 @@ packages: resolution: {integrity: sha512-uV2QOWP2nWzsy2aMp8aRibhi9dlzF5Hgh5SHaB9OiTGEyDTiJJyx0uy51QXdyWbtAHNua4XJzUKca3OzKUd3vA==} engines: {node: '>= 8'} - css-tree@2.3.1: - resolution: {integrity: sha512-6Fv1DV/TYw//QF5IzQdqsNDjx/wc8TrMBZsqjL9eW01tWb7R7k/mq+/VXfJCl7SoD5emsJop9cOByJZfs8hYIw==} - engines: {node: ^10 || ^12.20.0 || ^14.13.0 || >=15.0.0} - cssom@0.3.8: resolution: {integrity: sha512-b0tGHbfegbhPJpxpiBPU2sCkigAqtM9O121le6bbOlgyV+NyGyCmVfJ6QW9eRjz8CpNfWEOYBIMIGRYkLwsIYg==} @@ -2645,6 +2891,11 @@ packages: engines: {node: '>=18'} hasBin: true + esbuild@0.24.2: + resolution: {integrity: sha512-+9egpBW8I3CD5XPe0n6BfT5fxLzxrlDzqydF3aviG+9ni1lDC/OvMHcxqEFV0+LANZG5R1bFMWfUrjVsdwxJvA==} + engines: {node: '>=18'} + hasBin: true + escalade@3.2.0: resolution: {integrity: sha512-WUj2qlxaQtO4g6Pq5c29GTcWGDyd8itL8zTlipgECz3JesAiiOKotd8JU6otB3PACgG6xkJUyVhboMS+bje/jA==} engines: {node: '>=6'} @@ -2669,6 +2920,9 @@ packages: engines: {node: '>=4'} hasBin: true + esrap@1.3.2: + resolution: {integrity: sha512-C4PXusxYhFT98GjLSmb20k9PREuUdporer50dhzGuJu9IJXktbMddVCMLAERl5dAHyAi73GWWCE4FVHGP1794g==} + estraverse@5.3.0: resolution: {integrity: sha512-MMdARuVEQziNTeJD8DgMqmhwR11BRQ/cBP+pLtYdSTnf3MIO8fFeiINEbX36ZdNlfU/7A9f3gUw49B3oQsvwBA==} engines: {node: '>=4.0'} @@ -3247,9 +3501,6 @@ packages: resolution: {integrity: sha512-h5bgJWpxJNswbU7qCrV0tIKQCaS3blPDrqKWx+QxzuzL1zGUzij9XCWLrSLsJPu5t+eWA/ycetzYAO5IOMcWAQ==} hasBin: true - magic-string@0.30.14: - resolution: {integrity: sha512-5c99P1WKTed11ZC0HMJOj6CDIue6F8ySu+bJL+85q1zBEIY8IklrJ1eiKC2NDRh3Ct3FcvmJPyQHb9erXMTJNw==} - magic-string@0.30.17: resolution: {integrity: sha512-sNPKHvyjVf7gyjwS4xGTaW/mCnF8wnjtifKBEhxfZ7E/S8tQ0rssrwGNn6q8JH/ohItJfSQp9mBtQYuTlH5QnA==} @@ -3321,9 +3572,6 @@ packages: mdast-util-to-string@4.0.0: resolution: {integrity: sha512-0H44vDimn51F0YwvxSJSm0eCDOJTRlmN0R1yBh4HLj9wiV1Dn0QoXGbvFAWj2hSItVTlCmBF1hqKlIyUBVFLPg==} - mdn-data@2.0.30: - resolution: {integrity: sha512-GaqWWShW4kv/G9IEucWScBx9G1/vsFZZJUO+tD26M8J8z3Kw5RDQjaoZe03YAClgeS/SWPOcb4nkFBTEi5DUEA==} - media-typer@0.3.0: resolution: {integrity: sha512-dq+qelQ9akHpcOl/gUVRTxVIOkAJ1wR3QAvb4RsVjS8oVoFjDGTc679wJYmUmknUF5HwMLOgb5O+a3KxfWapPQ==} engines: {node: '>= 0.6'} @@ -3672,8 +3920,8 @@ packages: package-json-from-dist@1.0.1: resolution: {integrity: sha512-UEZIS3/by4OC8vL3P2dTXRETpebLI2NiI5vIrjaD/5UtrkFX/tNbwjTSRAGC/+7CAo2pIcBaRgWmcBBHcsaCIw==} - package-manager-detector@0.2.7: - resolution: {integrity: sha512-g4+387DXDKlZzHkP+9FLt8yKj8+/3tOkPv7DVTJGGRm00RkEWgqbFstX1mXJ4M0VDYhUqsTOiISqNOJnhAu3PQ==} + package-manager-detector@0.2.8: + resolution: {integrity: sha512-ts9KSdroZisdvKMWVAVCXiKqnqNfXz4+IbrBG8/BWx/TR5le+jfenvoBuIZ6UWM9nz47W7AbD9qYfAwfWMIwzA==} parse-json@5.2.0: resolution: {integrity: sha512-ayCKvm/phCGxOkYRSCM82iDwct8/EonSEgCSxWxD7ve6jHggsFl4fZVQBPRNgQoKiuV/odhFrGzQXZwbifC8Rg==} @@ -3742,9 +3990,6 @@ packages: perfect-debounce@1.0.0: resolution: {integrity: sha512-xCy9V055GLEqoFaHoC1SoLIaLmWctgCUaBaWxDZ7/Zx4CTyX7cJQLJOok/orfjZAh9kEYpjJa4d0KcJmCbctZA==} - periscopic@3.1.0: - resolution: {integrity: sha512-vKiQ8RRtkl9P+r/+oefh25C3fhybptkHKCZSPlcXiJux2tJF55GnEj3BVn4A5gKfq9NWWXXrxkHBwVPUfH0opw==} - picocolors@1.1.1: resolution: {integrity: sha512-xceH2snhtb5M9liqDsmEw56le376mTZkEX/jEb/RxNFyegNul7eNslCXP9FDj/Lcu0X8KEyMceP2ntpaHrDEVA==} @@ -3979,6 +4224,11 @@ packages: engines: {node: '>=18.0.0', npm: '>=8.0.0'} hasBin: true + rollup@4.29.1: + resolution: {integrity: sha512-RaJ45M/kmJUzSWDs1Nnd5DdV4eerC98idtUOVr6FfKcgxqvjwHmxc5upLF9qZU9EpsVzzhleFahrT3shLuJzIw==} + engines: {node: '>=18.0.0', npm: '>=8.0.0'} + hasBin: true + run-parallel@1.2.0: resolution: {integrity: sha512-5l4VyZR86LZ/lDxZTR6jqL8AFE2S0IFLMP26AbjsLVADxHdhB/c0GUsH+y39UfCi3dzz8OlQuPmnaJOMoDHQBA==} @@ -4235,12 +4485,6 @@ packages: peerDependencies: svelte: ^3.55.0 || ^4.0.0-next.0 || ^4.0.0 || ^5.0.0-next.0 - svelte-hmr@0.16.0: - resolution: {integrity: sha512-Gyc7cOS3VJzLlfj7wKS0ZnzDVdv3Pn2IuVeJPk9m2skfhcu5bq3wtIZyQGggr7/Iim5rH5cncyQft/kRLupcnA==} - engines: {node: ^12.20 || ^14.13.1 || >= 16} - peerDependencies: - svelte: ^3.19.0 || ^4.0.0 - svelte-preprocess@5.1.4: resolution: {integrity: sha512-IvnbQ6D6Ao3Gg6ftiM5tdbR6aAETwjhHV+UKGf5bHGYR69RQvF1ho0JKPcbUON4vy4R7zom13jPjgdOWCQ5hDA==} engines: {node: '>= 16.0.0'} @@ -4278,9 +4522,9 @@ packages: typescript: optional: true - svelte@4.2.19: - resolution: {integrity: sha512-IY1rnGr6izd10B0A8LqsBfmlT5OILVuZ7XsI0vdGPEvuonFV7NYEUK4dAkm9Zg2q0Um92kYjTpS1CAP3Nh/KWw==} - engines: {node: '>=16'} + svelte@5.15.0: + resolution: {integrity: sha512-YWl8rAd4hSjERLtLvP6h2pflGtmrJwv+L12BgrOtHYJCpvLS9WKp/YNAdyolw3FymXtcYZqhSWvWlu5O1X7tgQ==} + engines: {node: '>=18'} swr@2.2.5: resolution: {integrity: sha512-QtxqyclFeAsxEUeZIYmsaQ0UjimSq1RZ9Un7I68/0ClKK/U3LoyQunwkQfJZr2fc22DfIXLNDc2wFyTEikCUpg==} @@ -4654,10 +4898,50 @@ packages: yaml: optional: true - vitefu@0.2.5: - resolution: {integrity: sha512-SgHtMLoqaeeGnd2evZ849ZbACbnwQCIwRH57t18FxcXoZop0uQu0uzlIhJBlF/eWVzuce0sHeqPcDo+evVcg8Q==} + vite@6.0.5: + resolution: {integrity: sha512-akD5IAH/ID5imgue2DYhzsEwCi0/4VKY31uhMLEYJwPP4TiUp8pL5PIK+Wo7H8qT8JY9i+pVfPydcFPYD1EL7g==} + engines: {node: ^18.0.0 || ^20.0.0 || >=22.0.0} + hasBin: true + peerDependencies: + '@types/node': ^18.0.0 || ^20.0.0 || >=22.0.0 + jiti: '>=1.21.0' + less: '*' + lightningcss: ^1.21.0 + sass: '*' + sass-embedded: '*' + stylus: '*' + sugarss: '*' + terser: ^5.16.0 + tsx: ^4.8.1 + yaml: ^2.4.2 + peerDependenciesMeta: + '@types/node': + optional: true + jiti: + optional: true + less: + optional: true + lightningcss: + optional: true + sass: + optional: true + sass-embedded: + optional: true + stylus: + optional: true + sugarss: + optional: true + terser: + optional: true + tsx: + optional: true + yaml: + optional: true + + vitefu@1.0.4: + resolution: {integrity: sha512-y6zEE3PQf6uu/Mt6DTJ9ih+kyJLr4XcSgHR2zUkM8SWDhuixEJxfJ6CZGMHh1Ec3vPLoEA0IHU5oWzVqw8ulow==} peerDependencies: - vite: ^3.0.0 || ^4.0.0 || ^5.0.0 + vite: ^3.0.0 || ^4.0.0 || ^5.0.0 || ^6.0.0 peerDependenciesMeta: vite: optional: true @@ -4868,6 +5152,9 @@ packages: resolution: {integrity: sha512-cYVsTjKl8b+FrnidjibDWskAv7UKOfcwaVZdp/it9n1s9fU3IkgDbhdIRKCW4JDsAlECJY0ytoVPT3sK6kideA==} engines: {node: '>=18'} + zimmerframe@1.1.2: + resolution: {integrity: sha512-rAbqEGa8ovJy4pyBxZM70hg4pE6gDgaQ0Sl9M3enG3I0d6H4XSAM3GeNGLKnsBpuijUow064sf7ww1nutC5/3w==} + zwitch@2.0.4: resolution: {integrity: sha512-bXE4cR/kVZhKZX/RjPEflHaKVhUVl85noU3v6b8apfQEc1x4A+zBxjZ4lN8LqGd6WZ3dl98pY4o717VFmoPp+A==} @@ -4980,7 +5267,7 @@ snapshots: '@ampproject/remapping@2.3.0': dependencies: - '@jridgewell/gen-mapping': 0.3.5 + '@jridgewell/gen-mapping': 0.3.8 '@jridgewell/trace-mapping': 0.3.25 '@andrewbranch/untar.js@1.0.3': {} @@ -5033,7 +5320,7 @@ snapshots: '@babel/traverse': 7.26.4 '@babel/types': 7.26.3 convert-source-map: 2.0.0 - debug: 4.4.0 + debug: 4.4.0(supports-color@9.4.0) gensync: 1.0.0-beta.2 json5: 2.2.3 semver: 6.3.1 @@ -5124,7 +5411,7 @@ snapshots: '@babel/parser': 7.26.3 '@babel/template': 7.25.9 '@babel/types': 7.26.3 - debug: 4.4.0 + debug: 4.4.0(supports-color@9.4.0) globals: 11.12.0 transitivePeerDependencies: - supports-color @@ -5254,7 +5541,7 @@ snapshots: fs-extra: 7.0.1 mri: 1.2.0 p-limit: 2.3.0 - package-manager-detector: 0.2.7 + package-manager-detector: 0.2.8 picocolors: 1.1.1 resolve-from: 5.0.0 semver: 7.6.3 @@ -5391,141 +5678,216 @@ snapshots: '@esbuild/aix-ppc64@0.24.0': optional: true + '@esbuild/aix-ppc64@0.24.2': + optional: true + '@esbuild/android-arm64@0.21.5': optional: true '@esbuild/android-arm64@0.24.0': optional: true + '@esbuild/android-arm64@0.24.2': + optional: true + '@esbuild/android-arm@0.21.5': optional: true '@esbuild/android-arm@0.24.0': optional: true + '@esbuild/android-arm@0.24.2': + optional: true + '@esbuild/android-x64@0.21.5': optional: true '@esbuild/android-x64@0.24.0': optional: true + '@esbuild/android-x64@0.24.2': + optional: true + '@esbuild/darwin-arm64@0.21.5': optional: true '@esbuild/darwin-arm64@0.24.0': optional: true + '@esbuild/darwin-arm64@0.24.2': + optional: true + '@esbuild/darwin-x64@0.21.5': optional: true '@esbuild/darwin-x64@0.24.0': optional: true + '@esbuild/darwin-x64@0.24.2': + optional: true + '@esbuild/freebsd-arm64@0.21.5': optional: true '@esbuild/freebsd-arm64@0.24.0': optional: true + '@esbuild/freebsd-arm64@0.24.2': + optional: true + '@esbuild/freebsd-x64@0.21.5': optional: true '@esbuild/freebsd-x64@0.24.0': optional: true + '@esbuild/freebsd-x64@0.24.2': + optional: true + '@esbuild/linux-arm64@0.21.5': optional: true '@esbuild/linux-arm64@0.24.0': optional: true + '@esbuild/linux-arm64@0.24.2': + optional: true + '@esbuild/linux-arm@0.21.5': optional: true '@esbuild/linux-arm@0.24.0': optional: true + '@esbuild/linux-arm@0.24.2': + optional: true + '@esbuild/linux-ia32@0.21.5': optional: true '@esbuild/linux-ia32@0.24.0': optional: true + '@esbuild/linux-ia32@0.24.2': + optional: true + '@esbuild/linux-loong64@0.21.5': optional: true '@esbuild/linux-loong64@0.24.0': optional: true + '@esbuild/linux-loong64@0.24.2': + optional: true + '@esbuild/linux-mips64el@0.21.5': optional: true '@esbuild/linux-mips64el@0.24.0': optional: true + '@esbuild/linux-mips64el@0.24.2': + optional: true + '@esbuild/linux-ppc64@0.21.5': optional: true '@esbuild/linux-ppc64@0.24.0': optional: true + '@esbuild/linux-ppc64@0.24.2': + optional: true + '@esbuild/linux-riscv64@0.21.5': optional: true '@esbuild/linux-riscv64@0.24.0': optional: true + '@esbuild/linux-riscv64@0.24.2': + optional: true + '@esbuild/linux-s390x@0.21.5': optional: true '@esbuild/linux-s390x@0.24.0': optional: true + '@esbuild/linux-s390x@0.24.2': + optional: true + '@esbuild/linux-x64@0.21.5': optional: true '@esbuild/linux-x64@0.24.0': optional: true + '@esbuild/linux-x64@0.24.2': + optional: true + + '@esbuild/netbsd-arm64@0.24.2': + optional: true + '@esbuild/netbsd-x64@0.21.5': optional: true '@esbuild/netbsd-x64@0.24.0': optional: true + '@esbuild/netbsd-x64@0.24.2': + optional: true + '@esbuild/openbsd-arm64@0.24.0': optional: true + '@esbuild/openbsd-arm64@0.24.2': + optional: true + '@esbuild/openbsd-x64@0.21.5': optional: true '@esbuild/openbsd-x64@0.24.0': optional: true + '@esbuild/openbsd-x64@0.24.2': + optional: true + '@esbuild/sunos-x64@0.21.5': optional: true '@esbuild/sunos-x64@0.24.0': optional: true + '@esbuild/sunos-x64@0.24.2': + optional: true + '@esbuild/win32-arm64@0.21.5': optional: true '@esbuild/win32-arm64@0.24.0': optional: true + '@esbuild/win32-arm64@0.24.2': + optional: true + '@esbuild/win32-ia32@0.21.5': optional: true '@esbuild/win32-ia32@0.24.0': optional: true + '@esbuild/win32-ia32@0.24.2': + optional: true + '@esbuild/win32-x64@0.21.5': optional: true '@esbuild/win32-x64@0.24.0': optional: true + '@esbuild/win32-x64@0.24.2': + optional: true + '@floating-ui/core@1.6.8': dependencies: '@floating-ui/utils': 0.2.8 @@ -5813,13 +6175,13 @@ snapshots: - encoding - supports-color - '@rollup/pluginutils@5.1.3(rollup@4.28.1)': + '@rollup/pluginutils@5.1.3(rollup@4.29.1)': dependencies: '@types/estree': 1.0.6 estree-walker: 2.0.2 picomatch: 4.0.2 optionalDependencies: - rollup: 4.28.1 + rollup: 4.29.1 '@rollup/rollup-android-arm-eabi@4.28.0': optional: true @@ -5827,111 +6189,168 @@ snapshots: '@rollup/rollup-android-arm-eabi@4.28.1': optional: true + '@rollup/rollup-android-arm-eabi@4.29.1': + optional: true + '@rollup/rollup-android-arm64@4.28.0': optional: true '@rollup/rollup-android-arm64@4.28.1': optional: true + '@rollup/rollup-android-arm64@4.29.1': + optional: true + '@rollup/rollup-darwin-arm64@4.28.0': optional: true '@rollup/rollup-darwin-arm64@4.28.1': optional: true + '@rollup/rollup-darwin-arm64@4.29.1': + optional: true + '@rollup/rollup-darwin-x64@4.28.0': optional: true '@rollup/rollup-darwin-x64@4.28.1': optional: true + '@rollup/rollup-darwin-x64@4.29.1': + optional: true + '@rollup/rollup-freebsd-arm64@4.28.0': optional: true '@rollup/rollup-freebsd-arm64@4.28.1': optional: true + '@rollup/rollup-freebsd-arm64@4.29.1': + optional: true + '@rollup/rollup-freebsd-x64@4.28.0': optional: true '@rollup/rollup-freebsd-x64@4.28.1': optional: true + '@rollup/rollup-freebsd-x64@4.29.1': + optional: true + '@rollup/rollup-linux-arm-gnueabihf@4.28.0': optional: true '@rollup/rollup-linux-arm-gnueabihf@4.28.1': optional: true + '@rollup/rollup-linux-arm-gnueabihf@4.29.1': + optional: true + '@rollup/rollup-linux-arm-musleabihf@4.28.0': optional: true '@rollup/rollup-linux-arm-musleabihf@4.28.1': optional: true + '@rollup/rollup-linux-arm-musleabihf@4.29.1': + optional: true + '@rollup/rollup-linux-arm64-gnu@4.28.0': optional: true '@rollup/rollup-linux-arm64-gnu@4.28.1': optional: true + '@rollup/rollup-linux-arm64-gnu@4.29.1': + optional: true + '@rollup/rollup-linux-arm64-musl@4.28.0': optional: true '@rollup/rollup-linux-arm64-musl@4.28.1': optional: true + '@rollup/rollup-linux-arm64-musl@4.29.1': + optional: true + '@rollup/rollup-linux-loongarch64-gnu@4.28.1': optional: true + '@rollup/rollup-linux-loongarch64-gnu@4.29.1': + optional: true + '@rollup/rollup-linux-powerpc64le-gnu@4.28.0': optional: true '@rollup/rollup-linux-powerpc64le-gnu@4.28.1': optional: true + '@rollup/rollup-linux-powerpc64le-gnu@4.29.1': + optional: true + '@rollup/rollup-linux-riscv64-gnu@4.28.0': optional: true '@rollup/rollup-linux-riscv64-gnu@4.28.1': optional: true + '@rollup/rollup-linux-riscv64-gnu@4.29.1': + optional: true + '@rollup/rollup-linux-s390x-gnu@4.28.0': optional: true '@rollup/rollup-linux-s390x-gnu@4.28.1': optional: true + '@rollup/rollup-linux-s390x-gnu@4.29.1': + optional: true + '@rollup/rollup-linux-x64-gnu@4.28.0': optional: true '@rollup/rollup-linux-x64-gnu@4.28.1': optional: true + '@rollup/rollup-linux-x64-gnu@4.29.1': + optional: true + '@rollup/rollup-linux-x64-musl@4.28.0': optional: true '@rollup/rollup-linux-x64-musl@4.28.1': optional: true + '@rollup/rollup-linux-x64-musl@4.29.1': + optional: true + '@rollup/rollup-win32-arm64-msvc@4.28.0': optional: true '@rollup/rollup-win32-arm64-msvc@4.28.1': optional: true + '@rollup/rollup-win32-arm64-msvc@4.29.1': + optional: true + '@rollup/rollup-win32-ia32-msvc@4.28.0': optional: true '@rollup/rollup-win32-ia32-msvc@4.28.1': optional: true + '@rollup/rollup-win32-ia32-msvc@4.29.1': + optional: true + '@rollup/rollup-win32-x64-msvc@4.28.0': optional: true '@rollup/rollup-win32-x64-msvc@4.28.1': optional: true + '@rollup/rollup-win32-x64-msvc@4.29.1': + optional: true + '@shikijs/core@1.24.3': dependencies: '@shikijs/engine-javascript': 1.24.3 @@ -5992,7 +6411,7 @@ snapshots: '@size-limit/esbuild@11.1.6(size-limit@11.1.6)': dependencies: - esbuild: 0.24.0 + esbuild: 0.24.2 nanoid: 5.0.9 size-limit: 11.1.6 @@ -6006,49 +6425,48 @@ snapshots: '@size-limit/file': 11.1.6(size-limit@11.1.6) size-limit: 11.1.6 - '@sveltejs/adapter-auto@3.3.1(@sveltejs/kit@2.9.0(@sveltejs/vite-plugin-svelte@3.1.2(svelte@4.2.19)(vite@6.0.4(@types/node@22.10.2)(jiti@2.4.2)(yaml@2.5.1)))(svelte@4.2.19)(vite@6.0.4(@types/node@22.10.2)(jiti@2.4.2)(yaml@2.5.1)))': + '@sveltejs/adapter-auto@3.3.1(@sveltejs/kit@2.13.0(@sveltejs/vite-plugin-svelte@5.0.3(svelte@5.15.0)(vite@6.0.5(@types/node@22.10.2)(jiti@2.4.2)(yaml@2.5.1)))(svelte@5.15.0)(vite@6.0.5(@types/node@22.10.2)(jiti@2.4.2)(yaml@2.5.1)))': dependencies: - '@sveltejs/kit': 2.9.0(@sveltejs/vite-plugin-svelte@3.1.2(svelte@4.2.19)(vite@6.0.4(@types/node@22.10.2)(jiti@2.4.2)(yaml@2.5.1)))(svelte@4.2.19)(vite@6.0.4(@types/node@22.10.2)(jiti@2.4.2)(yaml@2.5.1)) + '@sveltejs/kit': 2.13.0(@sveltejs/vite-plugin-svelte@5.0.3(svelte@5.15.0)(vite@6.0.5(@types/node@22.10.2)(jiti@2.4.2)(yaml@2.5.1)))(svelte@5.15.0)(vite@6.0.5(@types/node@22.10.2)(jiti@2.4.2)(yaml@2.5.1)) import-meta-resolve: 4.1.0 - '@sveltejs/kit@2.9.0(@sveltejs/vite-plugin-svelte@3.1.2(svelte@4.2.19)(vite@6.0.4(@types/node@22.10.2)(jiti@2.4.2)(yaml@2.5.1)))(svelte@4.2.19)(vite@6.0.4(@types/node@22.10.2)(jiti@2.4.2)(yaml@2.5.1))': + '@sveltejs/kit@2.13.0(@sveltejs/vite-plugin-svelte@5.0.3(svelte@5.15.0)(vite@6.0.5(@types/node@22.10.2)(jiti@2.4.2)(yaml@2.5.1)))(svelte@5.15.0)(vite@6.0.5(@types/node@22.10.2)(jiti@2.4.2)(yaml@2.5.1))': dependencies: - '@sveltejs/vite-plugin-svelte': 3.1.2(svelte@4.2.19)(vite@6.0.4(@types/node@22.10.2)(jiti@2.4.2)(yaml@2.5.1)) + '@sveltejs/vite-plugin-svelte': 5.0.3(svelte@5.15.0)(vite@6.0.5(@types/node@22.10.2)(jiti@2.4.2)(yaml@2.5.1)) '@types/cookie': 0.6.0 cookie: 0.6.0 devalue: 5.1.1 esm-env: 1.2.1 import-meta-resolve: 4.1.0 kleur: 4.1.5 - magic-string: 0.30.14 + magic-string: 0.30.17 mrmime: 2.0.0 sade: 1.8.1 set-cookie-parser: 2.7.1 sirv: 3.0.0 - svelte: 4.2.19 + svelte: 5.15.0 tiny-glob: 0.2.9 - vite: 6.0.4(@types/node@22.10.2)(jiti@2.4.2)(yaml@2.5.1) + vite: 6.0.5(@types/node@22.10.2)(jiti@2.4.2)(yaml@2.5.1) - '@sveltejs/vite-plugin-svelte-inspector@2.1.0(@sveltejs/vite-plugin-svelte@3.1.2(svelte@4.2.19)(vite@6.0.4(@types/node@22.10.2)(jiti@2.4.2)(yaml@2.5.1)))(svelte@4.2.19)(vite@6.0.4(@types/node@22.10.2)(jiti@2.4.2)(yaml@2.5.1))': + '@sveltejs/vite-plugin-svelte-inspector@4.0.1(@sveltejs/vite-plugin-svelte@5.0.3(svelte@5.15.0)(vite@6.0.5(@types/node@22.10.2)(jiti@2.4.2)(yaml@2.5.1)))(svelte@5.15.0)(vite@6.0.5(@types/node@22.10.2)(jiti@2.4.2)(yaml@2.5.1))': dependencies: - '@sveltejs/vite-plugin-svelte': 3.1.2(svelte@4.2.19)(vite@6.0.4(@types/node@22.10.2)(jiti@2.4.2)(yaml@2.5.1)) - debug: 4.3.7(supports-color@9.4.0) - svelte: 4.2.19 - vite: 6.0.4(@types/node@22.10.2)(jiti@2.4.2)(yaml@2.5.1) + '@sveltejs/vite-plugin-svelte': 5.0.3(svelte@5.15.0)(vite@6.0.5(@types/node@22.10.2)(jiti@2.4.2)(yaml@2.5.1)) + debug: 4.4.0(supports-color@9.4.0) + svelte: 5.15.0 + vite: 6.0.5(@types/node@22.10.2)(jiti@2.4.2)(yaml@2.5.1) transitivePeerDependencies: - supports-color - '@sveltejs/vite-plugin-svelte@3.1.2(svelte@4.2.19)(vite@6.0.4(@types/node@22.10.2)(jiti@2.4.2)(yaml@2.5.1))': + '@sveltejs/vite-plugin-svelte@5.0.3(svelte@5.15.0)(vite@6.0.5(@types/node@22.10.2)(jiti@2.4.2)(yaml@2.5.1))': dependencies: - '@sveltejs/vite-plugin-svelte-inspector': 2.1.0(@sveltejs/vite-plugin-svelte@3.1.2(svelte@4.2.19)(vite@6.0.4(@types/node@22.10.2)(jiti@2.4.2)(yaml@2.5.1)))(svelte@4.2.19)(vite@6.0.4(@types/node@22.10.2)(jiti@2.4.2)(yaml@2.5.1)) - debug: 4.3.7(supports-color@9.4.0) + '@sveltejs/vite-plugin-svelte-inspector': 4.0.1(@sveltejs/vite-plugin-svelte@5.0.3(svelte@5.15.0)(vite@6.0.5(@types/node@22.10.2)(jiti@2.4.2)(yaml@2.5.1)))(svelte@5.15.0)(vite@6.0.5(@types/node@22.10.2)(jiti@2.4.2)(yaml@2.5.1)) + debug: 4.4.0(supports-color@9.4.0) deepmerge: 4.3.1 kleur: 4.1.5 - magic-string: 0.30.14 - svelte: 4.2.19 - svelte-hmr: 0.16.0(svelte@4.2.19) - vite: 6.0.4(@types/node@22.10.2)(jiti@2.4.2)(yaml@2.5.1) - vitefu: 0.2.5(vite@6.0.4(@types/node@22.10.2)(jiti@2.4.2)(yaml@2.5.1)) + magic-string: 0.30.17 + svelte: 5.15.0 + vite: 6.0.5(@types/node@22.10.2)(jiti@2.4.2)(yaml@2.5.1) + vitefu: 1.0.4(vite@6.0.5(@types/node@22.10.2)(jiti@2.4.2)(yaml@2.5.1)) transitivePeerDependencies: - supports-color @@ -6250,7 +6668,7 @@ snapshots: '@typescript/vfs@1.6.0(typescript@5.7.2)': dependencies: - debug: 4.4.0 + debug: 4.4.0(supports-color@9.4.0) typescript: 5.7.2 transitivePeerDependencies: - supports-color @@ -6264,14 +6682,14 @@ snapshots: transitivePeerDependencies: - '@swc/helpers' - '@vitejs/plugin-react@4.3.4(vite@6.0.4(@types/node@22.10.2)(jiti@2.4.2)(yaml@2.5.1))': + '@vitejs/plugin-react@4.3.4(vite@6.0.5(@types/node@22.10.2)(jiti@2.4.2)(yaml@2.5.1))': dependencies: '@babel/core': 7.26.0 '@babel/plugin-transform-react-jsx-self': 7.25.9(@babel/core@7.26.0) '@babel/plugin-transform-react-jsx-source': 7.25.9(@babel/core@7.26.0) '@types/babel__core': 7.20.5 react-refresh: 0.14.2 - vite: 6.0.4(@types/node@22.10.2)(jiti@2.4.2)(yaml@2.5.1) + vite: 6.0.5(@types/node@22.10.2)(jiti@2.4.2)(yaml@2.5.1) transitivePeerDependencies: - supports-color @@ -6285,16 +6703,16 @@ snapshots: vite: 6.0.4(@types/node@22.10.2)(jiti@2.4.2)(yaml@2.5.1) vue: 3.5.12(typescript@5.7.2) - '@vitest/coverage-v8@2.1.6(vitest@2.1.8(@types/node@22.10.1)(jsdom@20.0.3)(msw@2.7.0(@types/node@22.10.1)(typescript@5.7.2)))': + '@vitest/coverage-v8@2.1.8(vitest@2.1.8(@types/node@22.10.1)(jsdom@20.0.3)(msw@2.7.0(@types/node@22.10.1)(typescript@5.7.2)))': dependencies: '@ampproject/remapping': 2.3.0 '@bcoe/v8-coverage': 0.2.3 - debug: 4.3.7(supports-color@9.4.0) + debug: 4.4.0(supports-color@9.4.0) istanbul-lib-coverage: 3.2.2 istanbul-lib-report: 3.0.1 istanbul-lib-source-maps: 5.0.6 istanbul-reports: 3.1.7 - magic-string: 0.30.14 + magic-string: 0.30.17 magicast: 0.3.5 std-env: 3.8.0 test-exclude: 7.0.1 @@ -6576,6 +6994,10 @@ snapshots: acorn-walk: 8.3.4 optional: true + acorn-typescript@1.4.13(acorn@8.14.0): + dependencies: + acorn: 8.14.0 + acorn-walk@8.3.4: dependencies: acorn: 8.14.0 @@ -6585,14 +7007,14 @@ snapshots: agent-base@6.0.2: dependencies: - debug: 4.4.0 + debug: 4.4.0(supports-color@9.4.0) transitivePeerDependencies: - supports-color optional: true agent-base@7.1.1(supports-color@9.4.0): dependencies: - debug: 4.3.7(supports-color@9.4.0) + debug: 4.4.0(supports-color@9.4.0) transitivePeerDependencies: - supports-color @@ -6868,14 +7290,6 @@ snapshots: strip-ansi: 6.0.1 wrap-ansi: 7.0.0 - code-red@1.0.4: - dependencies: - '@jridgewell/sourcemap-codec': 1.5.0 - '@types/estree': 1.0.6 - acorn: 8.14.0 - estree-walker: 3.0.3 - periscopic: 3.1.0 - color-convert@2.0.1: dependencies: color-name: 1.1.4 @@ -6954,11 +7368,6 @@ snapshots: shebang-command: 2.0.0 which: 2.0.2 - css-tree@2.3.1: - dependencies: - mdn-data: 2.0.30 - source-map-js: 1.2.1 - cssom@0.3.8: optional: true @@ -6993,9 +7402,11 @@ snapshots: optionalDependencies: supports-color: 9.4.0 - debug@4.4.0: + debug@4.4.0(supports-color@9.4.0): dependencies: ms: 2.1.3 + optionalDependencies: + supports-color: 9.4.0 decamelize-keys@1.1.1: dependencies: @@ -7174,6 +7585,34 @@ snapshots: '@esbuild/win32-ia32': 0.24.0 '@esbuild/win32-x64': 0.24.0 + esbuild@0.24.2: + optionalDependencies: + '@esbuild/aix-ppc64': 0.24.2 + '@esbuild/android-arm': 0.24.2 + '@esbuild/android-arm64': 0.24.2 + '@esbuild/android-x64': 0.24.2 + '@esbuild/darwin-arm64': 0.24.2 + '@esbuild/darwin-x64': 0.24.2 + '@esbuild/freebsd-arm64': 0.24.2 + '@esbuild/freebsd-x64': 0.24.2 + '@esbuild/linux-arm': 0.24.2 + '@esbuild/linux-arm64': 0.24.2 + '@esbuild/linux-ia32': 0.24.2 + '@esbuild/linux-loong64': 0.24.2 + '@esbuild/linux-mips64el': 0.24.2 + '@esbuild/linux-ppc64': 0.24.2 + '@esbuild/linux-riscv64': 0.24.2 + '@esbuild/linux-s390x': 0.24.2 + '@esbuild/linux-x64': 0.24.2 + '@esbuild/netbsd-arm64': 0.24.2 + '@esbuild/netbsd-x64': 0.24.2 + '@esbuild/openbsd-arm64': 0.24.2 + '@esbuild/openbsd-x64': 0.24.2 + '@esbuild/sunos-x64': 0.24.2 + '@esbuild/win32-arm64': 0.24.2 + '@esbuild/win32-ia32': 0.24.2 + '@esbuild/win32-x64': 0.24.2 + escalade@3.2.0: {} escape-html@1.0.3: {} @@ -7193,6 +7632,10 @@ snapshots: esprima@4.0.1: {} + esrap@1.3.2: + dependencies: + '@jridgewell/sourcemap-codec': 1.5.0 + estraverse@5.3.0: optional: true @@ -7531,7 +7974,7 @@ snapshots: dependencies: '@tootallnate/once': 2.0.0 agent-base: 6.0.2 - debug: 4.4.0 + debug: 4.4.0(supports-color@9.4.0) transitivePeerDependencies: - supports-color optional: true @@ -7539,7 +7982,7 @@ snapshots: https-proxy-agent@5.0.1: dependencies: agent-base: 6.0.2 - debug: 4.4.0 + debug: 4.4.0(supports-color@9.4.0) transitivePeerDependencies: - supports-color optional: true @@ -7547,7 +7990,7 @@ snapshots: https-proxy-agent@7.0.5(supports-color@9.4.0): dependencies: agent-base: 7.1.1(supports-color@9.4.0) - debug: 4.3.7(supports-color@9.4.0) + debug: 4.4.0(supports-color@9.4.0) transitivePeerDependencies: - supports-color @@ -7650,7 +8093,7 @@ snapshots: istanbul-lib-source-maps@5.0.6: dependencies: '@jridgewell/trace-mapping': 0.3.25 - debug: 4.3.7(supports-color@9.4.0) + debug: 4.4.0(supports-color@9.4.0) istanbul-lib-coverage: 3.2.2 transitivePeerDependencies: - supports-color @@ -7821,18 +8264,14 @@ snapshots: lz-string@1.5.0: {} - magic-string@0.30.14: - dependencies: - '@jridgewell/sourcemap-codec': 1.5.0 - magic-string@0.30.17: dependencies: '@jridgewell/sourcemap-codec': 1.5.0 magicast@0.3.5: dependencies: - '@babel/parser': 7.26.2 - '@babel/types': 7.26.0 + '@babel/parser': 7.26.3 + '@babel/types': 7.26.3 source-map-js: 1.2.1 make-dir@4.0.0: @@ -7974,8 +8413,6 @@ snapshots: dependencies: '@types/mdast': 4.0.4 - mdn-data@2.0.30: {} - media-typer@0.3.0: {} meow@10.1.5: @@ -8115,7 +8552,7 @@ snapshots: micromark@4.0.1: dependencies: '@types/debug': 4.1.12 - debug: 4.4.0 + debug: 4.4.0(supports-color@9.4.0) decode-named-character-reference: 1.0.2 devlop: 1.1.0 micromark-core-commonmark: 2.0.2 @@ -8399,7 +8836,7 @@ snapshots: package-json-from-dist@1.0.1: {} - package-manager-detector@0.2.7: {} + package-manager-detector@0.2.8: {} parse-json@5.2.0: dependencies: @@ -8456,12 +8893,6 @@ snapshots: perfect-debounce@1.0.0: {} - periscopic@3.1.0: - dependencies: - '@types/estree': 1.0.6 - estree-walker: 3.0.3 - is-reference: 3.0.3 - picocolors@1.1.1: {} picomatch@2.3.1: {} @@ -8698,6 +9129,31 @@ snapshots: '@rollup/rollup-win32-x64-msvc': 4.28.1 fsevents: 2.3.3 + rollup@4.29.1: + dependencies: + '@types/estree': 1.0.6 + optionalDependencies: + '@rollup/rollup-android-arm-eabi': 4.29.1 + '@rollup/rollup-android-arm64': 4.29.1 + '@rollup/rollup-darwin-arm64': 4.29.1 + '@rollup/rollup-darwin-x64': 4.29.1 + '@rollup/rollup-freebsd-arm64': 4.29.1 + '@rollup/rollup-freebsd-x64': 4.29.1 + '@rollup/rollup-linux-arm-gnueabihf': 4.29.1 + '@rollup/rollup-linux-arm-musleabihf': 4.29.1 + '@rollup/rollup-linux-arm64-gnu': 4.29.1 + '@rollup/rollup-linux-arm64-musl': 4.29.1 + '@rollup/rollup-linux-loongarch64-gnu': 4.29.1 + '@rollup/rollup-linux-powerpc64le-gnu': 4.29.1 + '@rollup/rollup-linux-riscv64-gnu': 4.29.1 + '@rollup/rollup-linux-s390x-gnu': 4.29.1 + '@rollup/rollup-linux-x64-gnu': 4.29.1 + '@rollup/rollup-linux-x64-musl': 4.29.1 + '@rollup/rollup-win32-arm64-msvc': 4.29.1 + '@rollup/rollup-win32-ia32-msvc': 4.29.1 + '@rollup/rollup-win32-x64-msvc': 4.29.1 + fsevents: 2.3.3 + run-parallel@1.2.0: dependencies: queue-microtask: 1.2.3 @@ -9003,14 +9459,14 @@ snapshots: has-flag: 4.0.0 supports-color: 7.2.0 - svelte-check@3.8.6(@babel/core@7.26.0)(postcss@8.4.49)(svelte@4.2.19): + svelte-check@3.8.6(@babel/core@7.26.0)(postcss@8.4.49)(svelte@5.15.0): dependencies: '@jridgewell/trace-mapping': 0.3.25 chokidar: 3.6.0 picocolors: 1.1.1 sade: 1.8.1 - svelte: 4.2.19 - svelte-preprocess: 5.1.4(@babel/core@7.26.0)(postcss@8.4.49)(svelte@4.2.19)(typescript@5.7.2) + svelte: 5.15.0 + svelte-preprocess: 5.1.4(@babel/core@7.26.0)(postcss@8.4.49)(svelte@5.15.0)(typescript@5.7.2) typescript: 5.7.2 transitivePeerDependencies: - '@babel/core' @@ -9023,39 +9479,34 @@ snapshots: - stylus - sugarss - svelte-hmr@0.16.0(svelte@4.2.19): - dependencies: - svelte: 4.2.19 - - svelte-preprocess@5.1.4(@babel/core@7.26.0)(postcss@8.4.49)(svelte@4.2.19)(typescript@5.7.2): + svelte-preprocess@5.1.4(@babel/core@7.26.0)(postcss@8.4.49)(svelte@5.15.0)(typescript@5.7.2): dependencies: '@types/pug': 2.0.10 detect-indent: 6.1.0 magic-string: 0.30.17 sorcery: 0.11.1 strip-indent: 3.0.0 - svelte: 4.2.19 + svelte: 5.15.0 optionalDependencies: '@babel/core': 7.26.0 postcss: 8.4.49 typescript: 5.7.2 - svelte@4.2.19: + svelte@5.15.0: dependencies: '@ampproject/remapping': 2.3.0 '@jridgewell/sourcemap-codec': 1.5.0 - '@jridgewell/trace-mapping': 0.3.25 '@types/estree': 1.0.6 acorn: 8.14.0 + acorn-typescript: 1.4.13(acorn@8.14.0) aria-query: 5.3.2 axobject-query: 4.1.0 - code-red: 1.0.4 - css-tree: 2.3.1 - estree-walker: 3.0.3 + esm-env: 1.2.1 + esrap: 1.3.2 is-reference: 3.0.3 locate-character: 3.0.0 - magic-string: 0.30.14 - periscopic: 3.1.0 + magic-string: 0.30.17 + zimmerframe: 1.1.2 swr@2.2.5(react@18.3.1): dependencies: @@ -9277,9 +9728,9 @@ snapshots: unpipe@1.0.0: {} - unplugin-swc@1.5.1(@swc/core@1.10.1(@swc/helpers@0.5.13))(rollup@4.28.1): + unplugin-swc@1.5.1(@swc/core@1.10.1(@swc/helpers@0.5.13))(rollup@4.29.1): dependencies: - '@rollup/pluginutils': 5.1.3(rollup@4.28.1) + '@rollup/pluginutils': 5.1.3(rollup@4.29.1) '@swc/core': 1.10.1(@swc/helpers@0.5.13) load-tsconfig: 0.2.5 unplugin: 1.16.0 @@ -9335,7 +9786,7 @@ snapshots: debug: 4.3.7(supports-color@9.4.0) es-module-lexer: 1.5.4 pathe: 1.1.2 - vite: 6.0.4(@types/node@22.10.2)(jiti@2.4.2)(yaml@2.5.1) + vite: 6.0.5(@types/node@22.10.2)(jiti@2.4.2)(yaml@2.5.1) transitivePeerDependencies: - '@types/node' - jiti @@ -9353,7 +9804,7 @@ snapshots: vite-node@2.1.8(@types/node@22.10.1): dependencies: cac: 6.7.14 - debug: 4.4.0 + debug: 4.4.0(supports-color@9.4.0) es-module-lexer: 1.5.4 pathe: 1.1.2 vite: 5.4.11(@types/node@22.10.1) @@ -9371,7 +9822,7 @@ snapshots: vite-node@2.1.8(@types/node@22.10.2): dependencies: cac: 6.7.14 - debug: 4.4.0 + debug: 4.4.0(supports-color@9.4.0) es-module-lexer: 1.5.4 pathe: 1.1.2 vite: 5.4.11(@types/node@22.10.2) @@ -9390,7 +9841,7 @@ snapshots: dependencies: esbuild: 0.21.5 postcss: 8.4.49 - rollup: 4.28.1 + rollup: 4.29.1 optionalDependencies: '@types/node': 22.10.1 fsevents: 2.3.3 @@ -9399,7 +9850,7 @@ snapshots: dependencies: esbuild: 0.21.5 postcss: 8.4.49 - rollup: 4.28.1 + rollup: 4.29.1 optionalDependencies: '@types/node': 22.10.2 fsevents: 2.3.3 @@ -9415,9 +9866,20 @@ snapshots: jiti: 2.4.2 yaml: 2.5.1 - vitefu@0.2.5(vite@6.0.4(@types/node@22.10.2)(jiti@2.4.2)(yaml@2.5.1)): + vite@6.0.5(@types/node@22.10.2)(jiti@2.4.2)(yaml@2.5.1): + dependencies: + esbuild: 0.24.0 + postcss: 8.4.49 + rollup: 4.29.1 optionalDependencies: - vite: 6.0.4(@types/node@22.10.2)(jiti@2.4.2)(yaml@2.5.1) + '@types/node': 22.10.2 + fsevents: 2.3.3 + jiti: 2.4.2 + yaml: 2.5.1 + + vitefu@1.0.4(vite@6.0.5(@types/node@22.10.2)(jiti@2.4.2)(yaml@2.5.1)): + optionalDependencies: + vite: 6.0.5(@types/node@22.10.2)(jiti@2.4.2)(yaml@2.5.1) vitepress@1.5.0(@algolia/client-search@5.18.0)(@types/node@22.10.2)(@types/react@18.3.12)(axios@1.7.8)(change-case@5.4.4)(postcss@8.4.49)(react-dom@18.3.1(react@18.3.1))(react@18.3.1)(search-insights@2.13.0)(typescript@5.7.2): dependencies: @@ -9479,7 +9941,7 @@ snapshots: '@vitest/spy': 2.1.8 '@vitest/utils': 2.1.8 chai: 5.1.2 - debug: 4.4.0 + debug: 4.4.0(supports-color@9.4.0) expect-type: 1.1.0 magic-string: 0.30.17 pathe: 1.1.2 @@ -9515,7 +9977,7 @@ snapshots: '@vitest/spy': 2.1.8 '@vitest/utils': 2.1.8 chai: 5.1.2 - debug: 4.4.0 + debug: 4.4.0(supports-color@9.4.0) expect-type: 1.1.0 magic-string: 0.30.17 pathe: 1.1.2 @@ -9701,4 +10163,6 @@ snapshots: yoctocolors-cjs@2.1.2: {} + zimmerframe@1.1.2: {} + zwitch@2.0.4: {}